aws_sdk_applicationsignals/client/

list_entity_events.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListEntityEvents`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`entity(impl Into<String>, impl Into<String>)`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::entity) / [`set_entity(Option<HashMap::<String, String>>)`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::set_entity):<br>required: **true**<br><p>The entity for which to retrieve change events. This specifies the service, resource, or other entity whose event history you want to examine.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul>  <li>   <p><code>Type</code> designates the type of object this is.</p></li>  <li>   <p><code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p></li>  <li>   <p><code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p></li>  <li>   <p><code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p></li>  <li>   <p><code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p></li>  <li>   <p><code>AwsAccountId</code> specifies the account where this object is in.</p></li> </ul> <p>Below is an example of a service.</p> <p><code>{ "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" }</code></p> <p>Below is an example of a resource.</p> <p><code>{ "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" }</code></p><br>
    ///   - [`start_time(DateTime)`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::set_start_time):<br>required: **true**<br><p>The start of the time period to retrieve change events for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: <code>1698778057</code></p><br>
    ///   - [`end_time(DateTime)`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::set_end_time):<br>required: **true**<br><p>The end of the time period to retrieve change events for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: <code>1698778057</code></p><br>
    ///   - [`max_results(i32)`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of change events to return in one operation. If you omit this parameter, the default of 50 is used.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::set_next_token):<br>required: **false**<br><p>Include this value, if it was returned by the previous operation, to get the next set of change events.</p><br>
    /// - On success, responds with [`ListEntityEventsOutput`](crate::operation::list_entity_events::ListEntityEventsOutput) with field(s):
    ///   - [`start_time(DateTime)`](crate::operation::list_entity_events::ListEntityEventsOutput::start_time): <p>The start of the time period that the returned change events apply to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: <code>1698778057</code></p>
    ///   - [`end_time(DateTime)`](crate::operation::list_entity_events::ListEntityEventsOutput::end_time): <p>The end of the time period that the returned change events apply to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: <code>1698778057</code></p>
    ///   - [`change_events(Vec::<ChangeEvent>)`](crate::operation::list_entity_events::ListEntityEventsOutput::change_events): <p>An array of structures, where each structure contains information about one change event that occurred for the specified entity during the requested time period.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_entity_events::ListEntityEventsOutput::next_token): <p>Include this value in your next use of this API to get the next set of change events.</p>
    /// - On failure, responds with [`SdkError<ListEntityEventsError>`](crate::operation::list_entity_events::ListEntityEventsError)
    pub fn list_entity_events(&self) -> crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder {
        crate::operation::list_entity_events::builders::ListEntityEventsFluentBuilder::new(self.handle.clone())
    }
}