Struct aws_sdk_cloudtrail::operation::list_insights_metric_data::ListInsightsMetricDataInput
source · #[non_exhaustive]pub struct ListInsightsMetricDataInput {
pub event_source: Option<String>,
pub event_name: Option<String>,
pub insight_type: Option<InsightType>,
pub error_code: Option<String>,
pub start_time: Option<DateTime>,
pub end_time: Option<DateTime>,
pub period: Option<i32>,
pub data_type: Option<InsightsMetricDataType>,
pub max_results: Option<i32>,
pub next_token: Option<String>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.event_source: Option<String>
The Amazon Web Services service to which the request was made, such as iam.amazonaws.com
or s3.amazonaws.com
.
event_name: Option<String>
The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.
insight_type: Option<InsightType>
The type of CloudTrail Insights event, which is either ApiCallRateInsight
or ApiErrorRateInsight
. The ApiCallRateInsight
Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight
Insights type analyzes management API calls that result in error codes.
error_code: Option<String>
Conditionally required if the InsightType
parameter is set to ApiErrorRateInsight
.
If returning metrics for the ApiErrorRateInsight
Insights type, this is the error to retrieve data for. For example, AccessDenied
.
start_time: Option<DateTime>
Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.
The default is 90 days before the time of request.
end_time: Option<DateTime>
Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.
The default is the time of request.
period: Option<i32>
Granularity of data to retrieve, in seconds. Valid values are 60
, 300
, and 3600
. If you specify any other value, you will get an error. The default is 3600 seconds.
data_type: Option<InsightsMetricDataType>
Type of datapoints to return. Valid values are NonZeroData
and FillWithZeros
. The default is NonZeroData
.
max_results: Option<i32>
The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.
next_token: Option<String>
Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults
.
Add this parameter to the request to continue retrieving results starting from the last evaluated point.
Implementations§
source§impl ListInsightsMetricDataInput
impl ListInsightsMetricDataInput
sourcepub fn event_source(&self) -> Option<&str>
pub fn event_source(&self) -> Option<&str>
The Amazon Web Services service to which the request was made, such as iam.amazonaws.com
or s3.amazonaws.com
.
sourcepub fn event_name(&self) -> Option<&str>
pub fn event_name(&self) -> Option<&str>
The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.
sourcepub fn insight_type(&self) -> Option<&InsightType>
pub fn insight_type(&self) -> Option<&InsightType>
The type of CloudTrail Insights event, which is either ApiCallRateInsight
or ApiErrorRateInsight
. The ApiCallRateInsight
Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight
Insights type analyzes management API calls that result in error codes.
sourcepub fn error_code(&self) -> Option<&str>
pub fn error_code(&self) -> Option<&str>
Conditionally required if the InsightType
parameter is set to ApiErrorRateInsight
.
If returning metrics for the ApiErrorRateInsight
Insights type, this is the error to retrieve data for. For example, AccessDenied
.
sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.
The default is 90 days before the time of request.
sourcepub fn end_time(&self) -> Option<&DateTime>
pub fn end_time(&self) -> Option<&DateTime>
Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.
The default is the time of request.
sourcepub fn period(&self) -> Option<i32>
pub fn period(&self) -> Option<i32>
Granularity of data to retrieve, in seconds. Valid values are 60
, 300
, and 3600
. If you specify any other value, you will get an error. The default is 3600 seconds.
sourcepub fn data_type(&self) -> Option<&InsightsMetricDataType>
pub fn data_type(&self) -> Option<&InsightsMetricDataType>
Type of datapoints to return. Valid values are NonZeroData
and FillWithZeros
. The default is NonZeroData
.
sourcepub fn max_results(&self) -> Option<i32>
pub fn max_results(&self) -> Option<i32>
The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.
sourcepub fn next_token(&self) -> Option<&str>
pub fn next_token(&self) -> Option<&str>
Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults
.
Add this parameter to the request to continue retrieving results starting from the last evaluated point.
source§impl ListInsightsMetricDataInput
impl ListInsightsMetricDataInput
sourcepub fn builder() -> ListInsightsMetricDataInputBuilder
pub fn builder() -> ListInsightsMetricDataInputBuilder
Creates a new builder-style object to manufacture ListInsightsMetricDataInput
.
Trait Implementations§
source§impl Clone for ListInsightsMetricDataInput
impl Clone for ListInsightsMetricDataInput
source§fn clone(&self) -> ListInsightsMetricDataInput
fn clone(&self) -> ListInsightsMetricDataInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListInsightsMetricDataInput
impl Debug for ListInsightsMetricDataInput
source§impl PartialEq for ListInsightsMetricDataInput
impl PartialEq for ListInsightsMetricDataInput
source§fn eq(&self, other: &ListInsightsMetricDataInput) -> bool
fn eq(&self, other: &ListInsightsMetricDataInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ListInsightsMetricDataInput
Auto Trait Implementations§
impl Freeze for ListInsightsMetricDataInput
impl RefUnwindSafe for ListInsightsMetricDataInput
impl Send for ListInsightsMetricDataInput
impl Sync for ListInsightsMetricDataInput
impl Unpin for ListInsightsMetricDataInput
impl UnwindSafe for ListInsightsMetricDataInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more