aws_sdk_securityhub/client/

get_finding_history.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetFindingHistory`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`finding_identifier(AwsSecurityFindingIdentifier)`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::finding_identifier) / [`set_finding_identifier(Option<AwsSecurityFindingIdentifier>)`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::set_finding_identifier):<br>required: **true**<br><p>Identifies which finding to get the finding history for.</p><br>
    ///   - [`start_time(DateTime)`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::set_start_time):<br>required: **false**<br><p>A timestamp that indicates the start time of the requested finding history.</p> <p>If you provide values for both <code>StartTime</code> and <code>EndTime</code>, Security Hub returns finding history for the specified time period. If you provide a value for <code>StartTime</code> but not for <code>EndTime</code>, Security Hub returns finding history from the <code>StartTime</code> to the time at which the API is called. If you provide a value for <code>EndTime</code> but not for <code>StartTime</code>, Security Hub returns finding history from the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt">CreatedAt</a> timestamp of the finding to the <code>EndTime</code>. If you provide neither <code>StartTime</code> nor <code>EndTime</code>, Security Hub returns finding history from the <code>CreatedAt</code> timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p><br>
    ///   - [`end_time(DateTime)`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::set_end_time):<br>required: **false**<br><p>An ISO 8601-formatted timestamp that indicates the end time of the requested finding history.</p> <p>If you provide values for both <code>StartTime</code> and <code>EndTime</code>, Security Hub returns finding history for the specified time period. If you provide a value for <code>StartTime</code> but not for <code>EndTime</code>, Security Hub returns finding history from the <code>StartTime</code> to the time at which the API is called. If you provide a value for <code>EndTime</code> but not for <code>StartTime</code>, Security Hub returns finding history from the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt">CreatedAt</a> timestamp of the finding to the <code>EndTime</code>. If you provide neither <code>StartTime</code> nor <code>EndTime</code>, Security Hub returns finding history from the <code>CreatedAt</code> timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::set_next_token):<br>required: **false**<br><p>A token for pagination purposes. Provide <code>NULL</code> as the initial value. In subsequent requests, provide the token included in the response to get up to an additional 100 results of finding history. If you don’t provide <code>NextToken</code>, Security Hub returns up to 100 results of finding history for each request.</p><br>
    ///   - [`max_results(i32)`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to be returned. If you don’t provide it, Security Hub returns up to 100 results of finding history.</p><br>
    /// - On success, responds with [`GetFindingHistoryOutput`](crate::operation::get_finding_history::GetFindingHistoryOutput) with field(s):
    ///   - [`records(Option<Vec::<FindingHistoryRecord>>)`](crate::operation::get_finding_history::GetFindingHistoryOutput::records): <p>A list of events that altered the specified finding during the specified time period.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_finding_history::GetFindingHistoryOutput::next_token): <p>A token for pagination purposes. Provide this token in the subsequent request to <code>GetFindingsHistory</code> to get up to an additional 100 results of history for the same finding that you specified in your initial request.</p>
    /// - On failure, responds with [`SdkError<GetFindingHistoryError>`](crate::operation::get_finding_history::GetFindingHistoryError)
    pub fn get_finding_history(&self) -> crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder {
        crate::operation::get_finding_history::builders::GetFindingHistoryFluentBuilder::new(self.handle.clone())
    }
}