aws_sdk_detective/client/
get_investigation.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetInvestigation`](crate::operation::get_investigation::builders::GetInvestigationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`graph_arn(impl Into<String>)`](crate::operation::get_investigation::builders::GetInvestigationFluentBuilder::graph_arn) / [`set_graph_arn(Option<String>)`](crate::operation::get_investigation::builders::GetInvestigationFluentBuilder::set_graph_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the behavior graph.</p><br>
    ///   - [`investigation_id(impl Into<String>)`](crate::operation::get_investigation::builders::GetInvestigationFluentBuilder::investigation_id) / [`set_investigation_id(Option<String>)`](crate::operation::get_investigation::builders::GetInvestigationFluentBuilder::set_investigation_id):<br>required: **true**<br><p>The investigation ID of the investigation report.</p><br>
    /// - On success, responds with [`GetInvestigationOutput`](crate::operation::get_investigation::GetInvestigationOutput) with field(s):
    ///   - [`graph_arn(Option<String>)`](crate::operation::get_investigation::GetInvestigationOutput::graph_arn): <p>The Amazon Resource Name (ARN) of the behavior graph.</p>
    ///   - [`investigation_id(Option<String>)`](crate::operation::get_investigation::GetInvestigationOutput::investigation_id): <p>The investigation ID of the investigation report.</p>
    ///   - [`entity_arn(Option<String>)`](crate::operation::get_investigation::GetInvestigationOutput::entity_arn): <p>The unique Amazon Resource Name (ARN). Detective supports IAM user ARNs and IAM role ARNs.</p>
    ///   - [`entity_type(Option<EntityType>)`](crate::operation::get_investigation::GetInvestigationOutput::entity_type): <p>Type of entity. For example, Amazon Web Services accounts, such as an IAM user and/or IAM role.</p>
    ///   - [`created_time(Option<DateTime>)`](crate::operation::get_investigation::GetInvestigationOutput::created_time): <p>The creation time of the investigation report in UTC time stamp format.</p>
    ///   - [`scope_start_time(Option<DateTime>)`](crate::operation::get_investigation::GetInvestigationOutput::scope_start_time): <p>The start date and time used to set the scope time within which you want to generate the investigation report. The value is an UTC ISO8601 formatted string. For example, <code>2021-08-18T16:35:56.284Z</code>.</p>
    ///   - [`scope_end_time(Option<DateTime>)`](crate::operation::get_investigation::GetInvestigationOutput::scope_end_time): <p>The data and time when the investigation began. The value is an UTC ISO8601 formatted string. For example, <code>2021-08-18T16:35:56.284Z</code>.</p>
    ///   - [`status(Option<Status>)`](crate::operation::get_investigation::GetInvestigationOutput::status): <p>The status based on the completion status of the investigation.</p>
    ///   - [`severity(Option<Severity>)`](crate::operation::get_investigation::GetInvestigationOutput::severity): <p>The severity assigned is based on the likelihood and impact of the indicators of compromise discovered in the investigation.</p>
    ///   - [`state(Option<State>)`](crate::operation::get_investigation::GetInvestigationOutput::state): <p>The current state of the investigation. An archived investigation indicates that you have completed reviewing the investigation.</p>
    /// - On failure, responds with [`SdkError<GetInvestigationError>`](crate::operation::get_investigation::GetInvestigationError)
    pub fn get_investigation(&self) -> crate::operation::get_investigation::builders::GetInvestigationFluentBuilder {
        crate::operation::get_investigation::builders::GetInvestigationFluentBuilder::new(self.handle.clone())
    }
}