aws_sdk_continuum/client/create_code_finding.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateCodeFinding`](crate::operation::create_code_finding::builders::CreateCodeFindingFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`environment_id(impl Into<String>)`](crate::operation::create_code_finding::builders::CreateCodeFindingFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::create_code_finding::builders::CreateCodeFindingFluentBuilder::set_environment_id):<br>required: **true**<br>The environment to ingest the finding into.<br>
7 /// - [`ocsf_document(Document)`](crate::operation::create_code_finding::builders::CreateCodeFindingFluentBuilder::ocsf_document) / [`set_ocsf_document(Option<Document>)`](crate::operation::create_code_finding::builders::CreateCodeFindingFluentBuilder::set_ocsf_document):<br>required: **true**<br>The OCSF finding document to ingest, verbatim. Must declare a class_uid Continuum supports (2002 Vulnerability Finding, or 2007 Application Security Posture Finding) and validate against the vendored OCSF JSON Schema for that class, including the Continuum overlay requirements that finding_info.uid be present and that vulnerabilities\[0\].affected_code\[0\].file identify the code location. With several repositories in the environment, the file path must begin with the repository name. Maximum size 256 KB. Stored verbatim and normalized into the typed Finding members returned by GetCodeFinding. GetCodeFinding does not return the document itself.<br>
8 /// - [`client_token(impl Into<String>)`](crate::operation::create_code_finding::builders::CreateCodeFindingFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_code_finding::builders::CreateCodeFindingFluentBuilder::set_client_token):<br>required: **false**<br>Caller-provided idempotency token. A retry with the same token and an identical finding document replays the original result; the same token with different content is rejected.<br>
9 /// - On success, responds with [`CreateCodeFindingOutput`](crate::operation::create_code_finding::CreateCodeFindingOutput) with field(s):
10 /// - [`finding_id(String)`](crate::operation::create_code_finding::CreateCodeFindingOutput::finding_id): The unique identifier assigned to the finding.
11 /// - [`finding_arn(String)`](crate::operation::create_code_finding::CreateCodeFindingOutput::finding_arn): The ARN of the ingested finding.
12 /// - [`title(String)`](crate::operation::create_code_finding::CreateCodeFindingOutput::title): The title extracted from the submitted document. Always populated at ingestion.
13 /// - [`status(FindingStatus)`](crate::operation::create_code_finding::CreateCodeFindingOutput::status): The finding's current lifecycle status -- SUBMITTED for a newly ingested finding, or the finding's present status when an idempotent retry replays an already-processed finding.
14 /// - [`created_at(DateTime)`](crate::operation::create_code_finding::CreateCodeFindingOutput::created_at): The timestamp when the finding was ingested.
15 /// - On failure, responds with [`SdkError<CreateCodeFindingError>`](crate::operation::create_code_finding::CreateCodeFindingError)
16 pub fn create_code_finding(&self) -> crate::operation::create_code_finding::builders::CreateCodeFindingFluentBuilder {
17 crate::operation::create_code_finding::builders::CreateCodeFindingFluentBuilder::new(self.handle.clone())
18 }
19}