CloudTrailClient Class

Member Function Documentation

CloudTrailClient::CloudTrailClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a CloudTrailClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

CloudTrailClient::CloudTrailClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads CloudTrailClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddTagsResponse *CloudTrailClient::addTags(const AddTagsRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an AddTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home

[slot] CreateTrailResponse *CloudTrailClient::createTrail(const CreateTrailRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an CreateTrailResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were

[slot] DeleteTrailResponse *CloudTrailClient::deleteTrail(const DeleteTrailRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an DeleteTrailResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a trail. This operation must be called from the region in which the trail was created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all

[slot] DescribeTrailsResponse *CloudTrailClient::describeTrails(const DescribeTrailsRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an DescribeTrailsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves settings for the trail associated with the current region for your

[slot] GetEventSelectorsResponse *CloudTrailClient::getEventSelectors(const GetEventSelectorsRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an GetEventSelectorsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the

following> <ul> <li>

The S3 objects that you are logging for data

events> </li> <li>

If your event selector includes management

events> </li> <li>

If your event selector includes read-only events, write-only events, or all.

</p </li> </ul>

For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html">Logging Data and Management Events for Trails </a> in the <i>AWS CloudTrail User

[slot] GetTrailStatusResponse *CloudTrailClient::getTrailStatus(const GetTrailStatusRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an GetTrailStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each

[slot] ListPublicKeysResponse *CloudTrailClient::listPublicKeys(const ListPublicKeysRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an ListPublicKeysResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private

key> <note>

CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public

[slot] ListTagsResponse *CloudTrailClient::listTags(const ListTagsRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an ListTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the tags for the trail in the current

[slot] LookupEventsResponse *CloudTrailClient::lookupEvents(const LookupEventsRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an LookupEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <ul> <li>

Event

I> </li> <li>

Event

nam> </li> <li>

Event

sourc> </li> <li>

Resource

nam> </li> <li>

Resource

typ> </li> <li>

User

nam> </li> </ul>

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> <b>

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

occurs> </b> <b>

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

[slot] PutEventSelectorsResponse *CloudTrailClient::putEventSelectors(const PutEventSelectorsRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an PutEventSelectorsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Configures an event selector for your trail. Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

</p

Exampl> <ol> <li>

You create an event selector for a trail and specify that you want write-only

events> </li> <li>

The EC2 <code>GetConsoleOutput</code> and <code>RunInstances</code> API operations occur in your

account> </li> <li>

CloudTrail evaluates whether the events match your event

selectors> </li> <li>

The <code>RunInstances</code> is a write-only event and it matches your event selector. The trail logs the

event> </li> <li>

The <code>GetConsoleOutput</code> is a read-only event but it doesn't match your event selector. The trail doesn't log the event.

</p </li> </ol>

The <code>PutEventSelectors</code> operation must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is

thrown>

You can configure up to five event selectors for each trail. For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html">Logging Data and Management Events for Trails </a> in the <i>AWS CloudTrail User

[slot] RemoveTagsResponse *CloudTrailClient::removeTags(const RemoveTagsRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an RemoveTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes the specified tags from a

[slot] StartLoggingResponse *CloudTrailClient::startLogging(const StartLoggingRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an StartLoggingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all

[slot] StopLoggingResponse *CloudTrailClient::stopLogging(const StopLoggingRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an StopLoggingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an <code>InvalidHomeRegionException</code> will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all

[slot] UpdateTrailResponse *CloudTrailClient::updateTrail(const UpdateTrailRequest &request)

Sends request to the CloudTrailClient service, and returns a pointer to an UpdateTrailResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. <code>UpdateTrail</code> must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is