/AWS1/CL_TRLLSTINSIGHTSMETRI01

ListInsightsMetricDataResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_trailarn TYPE /AWS1/TRLSTRING /AWS1/TRLSTRING

Specifies the ARN of the trail. This is only returned when Insights is enabled on a trail logging data events.

iv_eventsource TYPE /AWS1/TRLEVENTSOURCE /AWS1/TRLEVENTSOURCE

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

iv_eventname TYPE /AWS1/TRLEVENTNAME /AWS1/TRLEVENTNAME

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

iv_insighttype TYPE /AWS1/TRLINSIGHTTYPE /AWS1/TRLINSIGHTTYPE

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.

iv_errorcode TYPE /AWS1/TRLERRORCODE /AWS1/TRLERRORCODE

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.

it_timestamps TYPE /AWS1/CL_TRLTIMESTAMPS_W=>TT_TIMESTAMPS TT_TIMESTAMPS

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

it_values TYPE /AWS1/CL_TRLINSIGHTSMETRICVA00=>TT_INSIGHTSMETRICVALUES TT_INSIGHTSMETRICVALUES

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.

iv_nexttoken TYPE /AWS1/TRLINSIGHTSMETRICNEXTTOK /AWS1/TRLINSIGHTSMETRICNEXTTOK

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.

---

Queryable Attributes

TrailARN

Specifies the ARN of the trail. This is only returned when Insights is enabled on a trail logging data events.

Accessible with the following methods

Method	Description
GET_TRAILARN()	Getter for TRAILARN, with configurable default
ASK_TRAILARN()	Getter for TRAILARN w/ exceptions if field has no value
HAS_TRAILARN()	Determine if TRAILARN has a value

EventSource

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

Accessible with the following methods

Method	Description
GET_EVENTSOURCE()	Getter for EVENTSOURCE, with configurable default
ASK_EVENTSOURCE()	Getter for EVENTSOURCE w/ exceptions if field has no value
HAS_EVENTSOURCE()	Determine if EVENTSOURCE has a value

EventName

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

Accessible with the following methods

Method	Description
GET_EVENTNAME()	Getter for EVENTNAME, with configurable default
ASK_EVENTNAME()	Getter for EVENTNAME w/ exceptions if field has no value
HAS_EVENTNAME()	Determine if EVENTNAME has a value

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.

Accessible with the following methods

Method	Description
GET_INSIGHTTYPE()	Getter for INSIGHTTYPE, with configurable default
ASK_INSIGHTTYPE()	Getter for INSIGHTTYPE w/ exceptions if field has no value
HAS_INSIGHTTYPE()	Determine if INSIGHTTYPE has a value

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.

Accessible with the following methods

Method	Description
GET_ERRORCODE()	Getter for ERRORCODE, with configurable default
ASK_ERRORCODE()	Getter for ERRORCODE w/ exceptions if field has no value
HAS_ERRORCODE()	Determine if ERRORCODE has a value

Timestamps

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

Accessible with the following methods

Method	Description
GET_TIMESTAMPS()	Getter for TIMESTAMPS, with configurable default
ASK_TIMESTAMPS()	Getter for TIMESTAMPS w/ exceptions if field has no value
HAS_TIMESTAMPS()	Determine if TIMESTAMPS has a value

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.

Accessible with the following methods

Method	Description
GET_VALUES()	Getter for VALUES, with configurable default
ASK_VALUES()	Getter for VALUES w/ exceptions if field has no value
HAS_VALUES()	Determine if VALUES has a value

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.

Accessible with the following methods

Method	Description
GET_NEXTTOKEN()	Getter for NEXTTOKEN, with configurable default
ASK_NEXTTOKEN()	Getter for NEXTTOKEN w/ exceptions if field has no value
HAS_NEXTTOKEN()	Determine if NEXTTOKEN has a value