C# (CSharp) Amazon.CloudTrail.Model Namespace

Nested Namespaces

Amazon.CloudTrail.Model.Internal

Classes

Name Description
AddTagsRequest Container for the parameters to the AddTags operation. 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 region).
CloudTrailARNInvalidException
CloudWatchLogsDeliveryUnavailableException
CreateTrailRequest Container for the parameters to the CreateTrail operation. 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 created.
CreateTrailResponse Returns the objects or data listed below if successful. Otherwise, returns an error.
CreateTrailResult Returns the objects or data listed below if successful. Otherwise, returns an error.
DataResource The Amazon S3 objects that you specify in your event selectors for your trail to log data events. Data events are object level API operations that access S3 objects, such as GetObject, DeleteObject, and PutObject. You can specify up to 50 S3 buckets and object prefixes for an event selector.

Example

  1. You create an event selector for a trail and specify an S3 bucket and an empty prefix, such as arn:aws:s3:::bucket-1/.

  2. You upload an image file to bucket-1.

  3. The PutObject API operation occurs on an object in the S3 bucket that you specified in the event selector. The trail processes and logs the event.

  4. You upload another image file to a different S3 bucket named arn:aws:s3:::bucket-2.

  5. The event occurs on an object in an S3 bucket that you didn't specify in the event selector. The trail doesn’t log the event.

DeleteTrailRequest Container for the parameters to the DeleteTrail operation.

Deletes a trail.

DeleteTrailResponse Returns information about the DeleteTrail response and response metadata.
DescribeTrailsRequest Container for the parameters to the DescribeTrails operation.

Retrieves the settings for some or all trails associated with an account. Returns a list of Trail structures in JSON format.

DescribeTrailsResponse Returns information about the DescribeTrails response and response metadata.
DescribeTrailsResult

Returns the objects or data listed below if successful. Otherwise, returns an error.

Event Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.
EventSelector Use event selectors to specify the types of events that you want your trail to log. When an event occurs in your account, CloudTrail evaluates the event selector for 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.

You can configure up to five event selectors for a trail.

GetEventSelectorsRequest Container for the parameters to the GetEventSelectors operation. Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
  • The S3 objects that you are logging for data events.

  • If your event selector includes management events.

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

For more information, see Configuring Event Selectors for Trails in the AWS CloudTrail User Guide.

GetEventSelectorsResponse This is the response object from the GetEventSelectors operation.
GetTrailStatusRequest Container for the parameters to the GetTrailStatus operation. 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 region.
GetTrailStatusResponse Returns information about the GetTrailStatus response and response metadata.
GetTrailStatusResult

Returns the objects or data listed below if successful. Otherwise, returns an error.

InsufficientEncryptionPolicyException
InsufficientS3BucketPolicyException
InsufficientSnsTopicPolicyException
InternalErrorException AmazonCloudTrail exception
InvalidCloudWatchLogsLogGroupArnException
InvalidCloudWatchLogsRoleArnException
InvalidEventSelectorsException
InvalidHomeRegionException
InvalidKmsKeyIdException
InvalidLookupAttributesException
InvalidMaxResultsException
InvalidNextTokenException
InvalidParameterCombinationException
InvalidS3BucketNameException
InvalidS3PrefixException
InvalidSnsTopicNameException
InvalidTagParameterException
InvalidTimeRangeException
InvalidTokenException
InvalidTrailNameException
KmsException
KmsKeyDisabledException
KmsKeyNotFoundException
ListPublicKeysRequest Container for the parameters to the ListPublicKeys operation. 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.

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 key.

ListPublicKeysResponse Returns the objects or data listed below if successful. Otherwise, returns an error.
ListTagsRequest Container for the parameters to the ListTags operation. Lists the tags for the trail in the current region.
ListTagsResponse Returns the objects or data listed below if successful. Otherwise, returns an error.
LookupEventsRequest 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 the following attributes:
  • Event ID

  • Event name

  • 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.

MaximumNumberOfTrailsExceededException
OperationNotPermittedException
PutEventSelectorsRequest Container for the parameters to the PutEventSelectors operation. Configures an event selector for your trail. Use event selectors to specify the type of events that you want your trail to log. 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.

Example

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

  2. The EC2 GetConsoleOutput and RunInstances API operations occur in your account.

  3. CloudTrail evaluates whether the events match your event selectors.

  4. The RunInstances is a write-only event and it matches your event selector. The trail logs the event.

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

The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

You can configure up to five event selectors for each trail. For more information, see Configuring Event Selectors for Trails in the AWS CloudTrail User Guide.

PutEventSelectorsResponse This is the response object from the PutEventSelectors operation.
RemoveTagsRequest Container for the parameters to the RemoveTags operation. Removes the specified tags from a trail.
ResourceNotFoundException
ResourceTypeNotSupportedException
S3BucketDoesNotExistException
StartLoggingRequest Container for the parameters to the StartLogging operation.

Starts the recording of AWS API calls and log file delivery for a trail.

StartLoggingResponse Returns information about the StartLogging response and response metadata.
StopLoggingRequest Container for the parameters to the StopLogging operation.

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.

StopLoggingResponse Returns information about the StopLogging response and response metadata.
TagsLimitExceededException
Trail The settings for a trail.
TrailAlreadyExistsException
TrailNotFoundException
TrailNotProvidedException
UnsupportedOperationException
UpdateTrailRequest Container for the parameters to the UpdateTrail operation. 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. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.
UpdateTrailResponse Returns the objects or data listed below if successful. Otherwise, returns an error.
UpdateTrailResult

Returns the objects or data listed below if successful. Otherwise, returns an error.