CloudTrailEventData (AWS CloudTrail Processing Library for Java

java.lang.Object
- com.amazonaws.services.cloudtrail.processinglibrary.model.internal.CloudTrailDataStore
- - com.amazonaws.services.cloudtrail.processinglibrary.model.CloudTrailEventData

```
public class CloudTrailEventData
extends CloudTrailDataStore
```
Contains information about requests for resources in your AWS account.
Information provided includes what services were accessed, what action was performed, and any parameters for the action. The request also provides information about who made the request.

See Also:

CloudTrail Event Reference

Constructor Summary

Constructors
Constructor and Description

CloudTrailEventData()

Constructors
Constructor and Description
`CloudTrailEventData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAccountId()` Get the AWS account ID from UserIdentity.
`Addendum`	`getAddendum()` Get the addendum
`java.lang.String`	`getAdditionalEventData()` Get additional API data.
`java.lang.String`	`getAnnotation()` Get the annotation
`java.lang.String`	`getApiVersion()` Get the API version.
`java.lang.String`	`getAwsRegion()` Get the AWS region for this event.
`java.lang.String`	`getEdgeDeviceDetails()` Get the edge device details
`java.lang.String`	`getErrorCode()` Get the API call error code.
`java.lang.String`	`getErrorMessage()` Get API call error message.
`java.lang.String`	`getEventCategory()` Get the event category.
`java.util.UUID`	`getEventId()` Get the event ID.
`java.lang.String`	`getEventName()` Get the event name for this event.
`java.lang.String`	`getEventSource()` Get the event source for this event.
`java.util.Date`	`getEventTime()` Get the event timestamp for this event.
`java.lang.String`	`getEventType()` Get the event type.
`java.lang.String`	`getEventVersion()` Get the event version.
`InsightDetails`	`getInsightDetails()` Get the insight details
`java.lang.String`	`getRecipientAccountId()` Get the recipient account ID
`java.lang.String`	`getRequestId()` Get the request ID.
`java.lang.String`	`getRequestParameters()` Get API call request parameters.
`java.util.List<Resource>`	`getResources()` Get the resources used in the operation.
`java.lang.String`	`getResponseElements()` Get API call response elements.
`java.lang.String`	`getServiceEventDetails()` Get aws service event details
`java.lang.String`	`getSessionCredentialFromConsole()` Check whether an event originated from an AWS Management Console session.
`java.lang.String`	`getSharedEventId()` Get the shared event ID
`java.lang.String`	`getSourceIPAddress()` Get the source IP address for this event.
`TlsDetails`	`getTlsDetails()` Get the TLS details
`java.lang.String`	`getUserAgent()` Get the event user agent for this event.
`UserIdentity`	`getUserIdentity()` Get the UserIdentity object held by this instance.
`java.lang.String`	`getVpcEndpointId()` Get the vpc endpoint ID
`java.lang.Boolean`	`isManagementEvent()` Check whether the event is a management event.
`java.lang.Boolean`	`isReadOnly()` Check whether the operation is read-only.

Methods inherited from class com.amazonaws.services.cloudtrail.processinglibrary.model.internal.CloudTrailDataStore
add, equals, get, has, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CloudTrailEventData
```
public CloudTrailEventData()
```
- Method Detail
  - getEventVersion
```
public java.lang.String getEventVersion()
```
    Get the event version.
    
    Returns:
    
    The version of the log event format. The current version is 1.02.
  - getUserIdentity
```
public UserIdentity getUserIdentity()
```
    Get the UserIdentity object held by this instance.
    
    Returns:
    
    Information about the user that made a request.
    
    See Also:
    
    userIdentity Element
  - getEventTime
```
public java.util.Date getEventTime()
```
    Get the event timestamp for this event.
    
    Returns:
    
    The date and time the request was made, in coordinated universal time (UTC).
  - getEventName
```
public java.lang.String getEventName()
```
    Get the event name for this event.
    
    Returns:
    
    The event name, an AWS CloudTrail action as listed in the API Reference.
    
    See Also:
    
    AWS CloudTrail Actions
  - getEventSource
```
public java.lang.String getEventSource()
```
    Get the event source for this event.
    
    Returns:
    
    The service that the request was made to. For example, a call to Amazon EC2 is listed in the eventSource field as ec2.amazonaws.com.
  - getAwsRegion
```
public java.lang.String getAwsRegion()
```
    Get the AWS region for this event.
    
    Returns:
    
    The AWS region that the request was made to.
  - getSourceIPAddress
```
public java.lang.String getSourceIPAddress()
```
    Get the source IP address for this event.
    For actions that originate from the service console, the address reported is for the underlying customer resource, not the console web server. For services in AWS, only the DNS name is displayed.
    
    Returns:
    
    The apparent IP address that the request was made from.
  - getUserAgent
```
public java.lang.String getUserAgent()
```
    Get the event user agent for this event.
    
    Returns:
    
    The agent through which the request was made, such as the AWS Management Console or an AWS SDK.
  - getRequestId
```
public java.lang.String getRequestId()
```
    Get the request ID.
    
    Returns:
    
    An identifier generated by the service being called to uniquely identify the request.
  - getErrorCode
```
public java.lang.String getErrorCode()
```
    Get the API call error code.
    
    Returns:
    
    The AWS service error if the request returns an error, or null if no error was returned.
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Get API call error message.
    This includes messages for authorization failures. For such messages, CloudTrail captures the message logged by the service in its exception handling.
    
    Returns:
    
    If the request returns an error, the description of the error, or null if there was no error.
  - getRequestParameters
```
public java.lang.String getRequestParameters()
```
    Get API call request parameters.
    API Request parameters are specific to both the AWS service and the API action that is being called. Refer to the API reference for the service identified in the request for more details about the parameters.
    
    Returns:
    
    The parameters, if any, that were sent with the request.
  - getResponseElements
```
public java.lang.String getResponseElements()
```
    Get API call response elements.
    If an action does not change state (for example, a request to get or list objects), this element is omitted. Response elements such as request parameters are documented in the API Reference documentation for the AWS service identified in the response.
    
    Returns:
    
    The response element for actions that make changes (such as the create, update, or delete actions).
  - getServiceEventDetails
```
public java.lang.String getServiceEventDetails()
```
    Get aws service event details
    This field will only be visible to awsServiceEvent type, it indicates what trigger the event and what the result of this event.
    
    Returns:
    
    The service event detail for an awsServiceEvent type event
  - getAdditionalEventData
```
public java.lang.String getAdditionalEventData()
```
    Get additional API data.
    
    Returns:
    
    Additional API call data set by AWS services.
  - getEventId
```
public java.util.UUID getEventId()
```
    Get the event ID.
    You can use this value to identify a single event. For example, you can use the ID as a primary key to retrieve log data from a searchable database.
    
    Returns:
    
    A GUID generated by CloudTrail to uniquely identify each event.
  - isReadOnly
```
public java.lang.Boolean isReadOnly()
```
    Check whether the operation is read-only.
    
    Returns:
    
    true if the operation identified in the log is read-only.
  - isManagementEvent
```
public java.lang.Boolean isManagementEvent()
```
    Check whether the event is a management event.
    
    Returns:
    
    true if the event identified in the log is a management event.
  - getResources
```
public java.util.List<Resource> getResources()
```
    Get the resources used in the operation.
    
    Returns:
    
    A list of resources used in this operation.
  - getAccountId
```
public java.lang.String getAccountId()
```
    Get the AWS account ID from UserIdentity.
    If the request was made using temporary security credentials, this is the account that owns the IAM user or role that was used to obtain credentials.
    
    Returns:
    
    The account that owns the entity that granted permissions for the request.
  - getEventCategory
```
public java.lang.String getEventCategory()
```
    Get the event category.
    
    Returns:
    
    Identifies the category of CloudTrail event.
  - getEventType
```
public java.lang.String getEventType()
```
    Get the event type.
    
    Returns:
    
    Identifies the type of event that generated the event.
  - getApiVersion
```
public java.lang.String getApiVersion()
```
    Get the API version.
    
    Returns:
    
    the API version associated with the AWS API call's eventType value.
  - getRecipientAccountId
```
public java.lang.String getRecipientAccountId()
```
    Get the recipient account ID
    
    Returns:
    
    the account ID that received this event.
  - getSharedEventId
```
public java.lang.String getSharedEventId()
```
    Get the shared event ID
    
    Returns:
    
    When recipientAccountList has size greater than 1, then sharedEventID is generated to indicate multiple CloudTrail events originate from a single service event.
  - getAnnotation
```
public java.lang.String getAnnotation()
```
    Get the annotation
    
    Returns:
    
    User provided annotation tagging delivered by CloudTrail.
  - getVpcEndpointId
```
public java.lang.String getVpcEndpointId()
```
    Get the vpc endpoint ID
    
    Returns:
    
    The VPC endpoint in which requests were made from a VPC to another AWS service, such as Amazon S3.
  - getInsightDetails
```
public InsightDetails getInsightDetails()
```
    Get the insight details
    
    Returns:
    
    information about the underlying triggers of an Insights event, such as event source, statistics, API name, and whether the event is the start or end of the Insights event.
  - getAddendum
```
public Addendum getAddendum()
```
    Get the addendum
    The Addendum block of an addendum event includes details to fill an auditing gap or update an older event. It only appears to update an older event.
    
    Returns:
    
    Details of an Addendum block, such as a reason for the addendum, updated fields, original request ID, and original event ID..
  - getEdgeDeviceDetails
```
public java.lang.String getEdgeDeviceDetails()
```
    Get the edge device details
    
    Returns:
    
    Information about the edge device, such as device type, device ID.
  - getTlsDetails
```
public TlsDetails getTlsDetails()
```
    Get the TLS details
    Shows information about the Transport Layer Security (TLS) version, cipher suites, and FQDN of the client-provided host name of the service API call.
    
    Returns:
    
    The TLS details of a service API call.
  - getSessionCredentialFromConsole
```
public java.lang.String getSessionCredentialFromConsole()
```
    Check whether an event originated from an AWS Management Console session.
    The field is not shown unless the value is true, meaning that the client that was used to make the API call was either a proxy or an external client.
    
    Returns:
    
    true if the event originated from an AWS Management Console session.

Class CloudTrailEventData

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.services.cloudtrail.processinglibrary.model.internal.CloudTrailDataStore

Methods inherited from class java.lang.Object

Constructor Detail

CloudTrailEventData

Method Detail

getEventVersion

getUserIdentity

getEventTime

getEventName

getEventSource

getAwsRegion

getSourceIPAddress

getUserAgent

getRequestId

getErrorCode

getErrorMessage

getRequestParameters

getResponseElements

getServiceEventDetails

getAdditionalEventData

getEventId

isReadOnly

isManagementEvent

getResources

getAccountId

getEventCategory

getEventType

getApiVersion

getRecipientAccountId

getSharedEventId

getAnnotation

getVpcEndpointId

getInsightDetails

getAddendum

getEdgeDeviceDetails

getTlsDetails

getSessionCredentialFromConsole