AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the LookupEvents operation against AWS CloudTrail.

Syntax

Find-CTEvent
-EndTime <DateTime>
-LookupAttribute <LookupAttribute[]>
-StartTime <DateTime>
-MaxResult <Int32>
-NextToken <String>

Description

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 the following attributes:
  • Event ID
  • Event name
  • Event source
  • Resource name
  • Resource type
  • User name
All attributes are optional. 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. The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs. Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias, Find-CTEvents.

Parameters

-EndTime <DateTime>
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.
Required?False
Position?Named
Accept pipeline input?False
-LookupAttribute <LookupAttribute[]>
Contains a list of lookup attributes. Currently the list can contain only one item.
Required?False
Position?Named
Accept pipeline input?False
-MaxResult <Int32>
The number of events to return. Possible values are 1 through 50. The default is 10.
Required?False
Position?Named
Accept pipeline input?False
-NextToken <String>
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.
Required?False
Position?Named
Accept pipeline input?False
-StartTime <DateTime>
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.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

This cmdlet does not accept pipeline input.

Outputs

This cmdlet returns a collection of Event objects. The service call response (type Amazon.CloudTrail.Model.LookupEventsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)

Examples

Example 1

PS C:\>Find-CTEvent
Returns all events that have occurred over the last seven days. The cmdlet by default automatically makes multiple calls to deliver all events, exiting when the service indicates no further data is available.

Example 2

PS C:\>Find-CTEvent -Region eu-central-1
Returns all events that have occurred over the last seven days specifying a region that is not the current shell default.

Example 3

PS C:\>Find-CTEvent -LookupAttribute @{ AttributeKey="EventName"; AttributeValue="RunInstances" }
Returns all events that are associated with the RunInstances API call.

Example 4

PS C:\>Find-CTEvent -MaxResult 5
Returns the first 5 available events. The token to use to retrieve further events is attached as a note property named 'NextToken' to the $AWSHistory.LastServiceResponse member.

Example 5

PS C:\>Find-CTEvent -MaxResult 10 -NextToken $AWSHistory.LastServiceResponse.NextToken
Returns the next 10 events using the 'next page' token from a previous call to indicate where to start returning events from in the sequence.

Example 6

$nextToken = $null
do
{
Find-CTEvent -MaxResult 5 -NextToken $nextToken
$nextToken = $AWSHistory.LastServiceResponse.NextToken
} while ($nextToken -ne $null)
This example shows how to loop through the available events using manual paging, fetching a maximum of 5 events per call.

Supported Version

AWS Tools for PowerShell: 2.x.y.z