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

Class ListInsightsMetricDataResponse

    • Method Detail

      • eventSource

        public final String eventSource()

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

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

      • eventName

        public final String eventName()

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

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

      • insightType

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, insightType will return InsightType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from insightTypeAsString().

        Returns:
        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.
        See Also:
        InsightType

      • insightTypeAsString

        public final String insightTypeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, insightType will return InsightType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from insightTypeAsString().

        Returns:
        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.
        See Also:
        InsightType

      • errorCode

        public final String errorCode()

        Only returned if InsightType parameter was set to ApiErrorRateInsight.

        If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

        Returns:
        Only returned if InsightType parameter was set to ApiErrorRateInsight.

        If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

      • hasTimestamps

        public final boolean hasTimestamps()
        For responses, this returns true if the service returned a value for the Timestamps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • timestamps

        public final List<Instant> timestamps()

        List of timestamps at intervals corresponding to the specified time period.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTimestamps() method.

        Returns:
        List of timestamps at intervals corresponding to the specified time period.

      • hasValues

        public final boolean hasValues()
        For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • values

        public final List<Double> values()

        List of values representing the API call rate or error rate at each timestamp. The number of values is equal to the number of timestamps.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

        Returns:
        List of values representing the API call rate or error rate at each timestamp. The number of values is equal to the number of timestamps.

      • nextToken

        public final String nextToken()

        Only returned if the full results could not be returned in a single query. You can set the NextToken parameter in the next request to this value to continue retrieval.

        Returns:
        Only returned if the full results could not be returned in a single query. You can set the NextToken parameter in the next request to this value to continue retrieval.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object