Package software.amazon.awssdk.services.cloudtrail.model

Interface ListInsightsMetricDataRequest.Builder

    • Method Detail

      • eventSource

        ListInsightsMetricDataRequest.Builder eventSource​(String eventSource)

        The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

        Parameters:
        eventSource - The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventName

        ListInsightsMetricDataRequest.Builder eventName​(String eventName)

        The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

        Parameters:
        eventName - The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • insightType

        ListInsightsMetricDataRequest.Builder insightType​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InsightType, InsightType

      • insightType

        ListInsightsMetricDataRequest.Builder insightType​(InsightType 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InsightType, InsightType

      • errorCode

        ListInsightsMetricDataRequest.Builder errorCode​(String errorCode)

        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.

        Parameters:
        errorCode - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startTime

        ListInsightsMetricDataRequest.Builder startTime​(Instant startTime)

        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.

        Parameters:
        startTime - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endTime

        ListInsightsMetricDataRequest.Builder endTime​(Instant endTime)

        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.

        Parameters:
        endTime - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • period

        ListInsightsMetricDataRequest.Builder period​(Integer period)

        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.

        Parameters:
        period - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataType

        ListInsightsMetricDataRequest.Builder dataType​(String dataType)

        Type of datapoints to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

        Parameters:
        dataType - Type of datapoints to return. Valid values are NonZeroData and FillWithZeros . The default is NonZeroData.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InsightsMetricDataType, InsightsMetricDataType

      • maxResults

        ListInsightsMetricDataRequest.Builder maxResults​(Integer maxResults)

        The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.

        Parameters:
        maxResults - The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListInsightsMetricDataRequest.Builder nextToken​(String nextToken)

        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.

        Parameters:
        nextToken - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.