com.amazonaws.services.cloudtrail.model

Class LookupEventsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudtrail.model.LookupEventsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class LookupEventsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the LookupEvents operation.

Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

IMPORTANT:The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

IMPORTANT:Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

See Also:

AWSCloudTrail.lookupEvents(LookupEventsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
LookupEventsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
LookupEventsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Date	getEndTime() Specifies that only events that occur before or at the specified time are returned.
List<LookupAttribute>	getLookupAttributes() Contains a list of lookup attributes.
Integer	getMaxResults() The number of events to return.
String	getNextToken() The token to use to get the next page of results after a previous API call.
Date	getStartTime() Specifies that only events that occur after or at the specified time are returned.
int	hashCode()
void	setEndTime(Date endTime) Specifies that only events that occur before or at the specified time are returned.
void	setLookupAttributes(Collection<LookupAttribute> lookupAttributes) Contains a list of lookup attributes.
void	setMaxResults(Integer maxResults) The number of events to return.
void	setNextToken(String nextToken) The token to use to get the next page of results after a previous API call.
void	setStartTime(Date startTime) Specifies that only events that occur after or at the specified time are returned.
String	toString() Returns a string representation of this object; useful for testing and debugging.
LookupEventsRequest	withEndTime(Date endTime) Specifies that only events that occur before or at the specified time are returned.
LookupEventsRequest	withLookupAttributes(Collection<LookupAttribute> lookupAttributes) Contains a list of lookup attributes.
LookupEventsRequest	withLookupAttributes(LookupAttribute... lookupAttributes) Contains a list of lookup attributes.
LookupEventsRequest	withMaxResults(Integer maxResults) The number of events to return.
LookupEventsRequest	withNextToken(String nextToken) The token to use to get the next page of results after a previous API call.
LookupEventsRequest	withStartTime(Date startTime) Specifies that only events that occur after or at the specified time are returned.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LookupEventsRequest

public LookupEventsRequest()

Method Detail

getLookupAttributes

public List<LookupAttribute> getLookupAttributes()

Contains a list of lookup attributes. Currently the list can contain only one item.

Returns:

Contains a list of lookup attributes. Currently the list can contain only one item.

setLookupAttributes

public void setLookupAttributes(Collection<LookupAttribute> lookupAttributes)

Contains a list of lookup attributes. Currently the list can contain only one item.

Parameters:

lookupAttributes - Contains a list of lookup attributes. Currently the list can contain only one item.

withLookupAttributes

public LookupEventsRequest withLookupAttributes(LookupAttribute... lookupAttributes)

Contains a list of lookup attributes. Currently the list can contain only one item.

NOTE: This method appends the values to the existing list (if any). Use setLookupAttributes(java.util.Collection) or withLookupAttributes(java.util.Collection) if you want to override the existing values.

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

Parameters:

lookupAttributes - Contains a list of lookup attributes. Currently the list can contain only one item.

Returns:

A reference to this updated object so that method calls can be chained together.

withLookupAttributes

public LookupEventsRequest withLookupAttributes(Collection<LookupAttribute> lookupAttributes)

Contains a list of lookup attributes. Currently the list can contain only one item.

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

Parameters:

lookupAttributes - Contains a list of lookup attributes. Currently the list can contain only one item.

Returns:

A reference to this updated object so that method calls can be chained together.

getStartTime

public Date getStartTime()

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

Returns:

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

setStartTime

public void setStartTime(Date startTime)

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

Parameters:

startTime - Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

withStartTime

public LookupEventsRequest withStartTime(Date startTime)

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

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

Parameters:

startTime - Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

Returns:

A reference to this updated object so that method calls can be chained together.

getEndTime

public Date getEndTime()

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

Returns:

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

setEndTime

public void setEndTime(Date endTime)

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

Parameters:

endTime - Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

withEndTime

public LookupEventsRequest withEndTime(Date endTime)

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

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

Parameters:

endTime - Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

The number of events to return. Possible values are 1 through 50. The default is 10.

Constraints:
Range: 1 - 50

Returns:

The number of events to return. Possible values are 1 through 50. The default is 10.

setMaxResults

public void setMaxResults(Integer maxResults)

The number of events to return. Possible values are 1 through 50. The default is 10.

Constraints:
Range: 1 - 50

Parameters:

maxResults - The number of events to return. Possible values are 1 through 50. The default is 10.

withMaxResults

public LookupEventsRequest withMaxResults(Integer maxResults)

The number of events to return. Possible values are 1 through 50. The default is 10.

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

Constraints:
Range: 1 - 50

Parameters:

maxResults - The number of events to return. Possible values are 1 through 50. The default is 10.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

Returns:

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

setNextToken

public void setNextToken(String nextToken)

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

Parameters:

nextToken - The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

withNextToken

public LookupEventsRequest withNextToken(String nextToken)

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

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

Parameters:

nextToken - The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public LookupEventsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()