DataFire integration for AWS CloudTrail
npm install @datafire/amazonaws_cloudtrailClient library for AWS CloudTrail
bash
npm install --save @datafire/amazonaws_cloudtrail
`
js
let amazonaws_cloudtrail = require('@datafire/amazonaws_cloudtrail').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});amazonaws_cloudtrail.AddTags({
"ResourceId": ""
}).then(data => {
console.log(data);
});
`Description
AWS CloudTrail
This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.
As an alternative to the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.
See the AWS CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.
Actions
$3
js
amazonaws_cloudtrail.AddTags({
"ResourceId": ""
}, context)
`#### Input
* input
* ResourceId required String
* TagsList TagsList#### Output
* output AddTagsResponse
$3
js
amazonaws_cloudtrail.CreateTrail({
"Name": "",
"S3BucketName": ""
}, context)
`#### Input
* input
* CloudWatchLogsLogGroupArn String
* CloudWatchLogsRoleArn String
* EnableLogFileValidation Boolean
* IncludeGlobalServiceEvents Boolean
* IsMultiRegionTrail Boolean
* KmsKeyId String
* Name required String
* S3BucketName required String
* S3KeyPrefix String
* SnsTopicName String#### Output
* output CreateTrailResponse
$3
js
amazonaws_cloudtrail.DeleteTrail({
"Name": ""
}, context)
`#### Input
* input
* Name required String#### Output
* output DeleteTrailResponse
$3
js
amazonaws_cloudtrail.DescribeTrails({}, context)
`#### Input
* input
* includeShadowTrails Boolean
* trailNameList TrailNameList#### Output
* output DescribeTrailsResponse
$3
js
amazonaws_cloudtrail.GetEventSelectors({
"TrailName": ""
}, context)
`#### Input
* input
* TrailName required String#### Output
* output GetEventSelectorsResponse
$3
js
amazonaws_cloudtrail.GetTrailStatus({
"Name": ""
}, context)
`#### Input
* input
* Name required String#### Output
* output GetTrailStatusResponse
$3
js
amazonaws_cloudtrail.ListPublicKeys({}, context)
`#### Input
* input
* EndTime Date
* NextToken String
* StartTime Date#### Output
* output ListPublicKeysResponse
$3
js
amazonaws_cloudtrail.ListTags({
"ResourceIdList": []
}, context)
`#### Input
* input
* NextToken String
* ResourceIdList required ResourceIdList#### Output
* output ListTagsResponse
$3
js
amazonaws_cloudtrail.LookupEvents({}, context)
`#### Input
* input
* MaxResults
* NextToken
* EndTime Date
* LookupAttributes LookupAttributesList
* MaxResults MaxResults
* NextToken NextToken
* StartTime Date#### Output
* output LookupEventsResponse
$3
js
amazonaws_cloudtrail.PutEventSelectors({
"TrailName": "",
"EventSelectors": []
}, context)
`#### Input
* input
* EventSelectors required EventSelectors
* TrailName required String#### Output
* output PutEventSelectorsResponse
$3
js
amazonaws_cloudtrail.RemoveTags({
"ResourceId": ""
}, context)
`#### Input
* input
* ResourceId required String
* TagsList TagsList#### Output
* output RemoveTagsResponse
$3
js
amazonaws_cloudtrail.StartLogging({
"Name": ""
}, context)
`#### Input
* input
* Name required String#### Output
* output StartLoggingResponse
$3
js
amazonaws_cloudtrail.StopLogging({
"Name": ""
}, context)
`#### Input
* input
* Name required String#### Output
* output StopLoggingResponse
$3
js
amazonaws_cloudtrail.UpdateTrail({
"Name": ""
}, context)
`#### Input
* input
* CloudWatchLogsLogGroupArn String
* CloudWatchLogsRoleArn String
* EnableLogFileValidation Boolean
* IncludeGlobalServiceEvents Boolean
* IsMultiRegionTrail Boolean
* KmsKeyId String
* Name required String
* S3BucketName String
* S3KeyPrefix String
* SnsTopicName String#### Output
* output UpdateTrailResponse
Definitions
$3
* AddTagsRequest : Specifies the tags to add to a trail.
* ResourceId required String
* TagsList TagsList$3
* AddTagsResponse object: Returns the objects or data listed below if successful. Otherwise, returns an error.$3
* Boolean boolean$3
* ByteBuffer $3
* CloudTrailARNInvalidException : This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is:
arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
$3
* CloudWatchLogsDeliveryUnavailableException object: Cannot set a CloudWatch Logs delivery for this region.$3
* CreateTrailRequest object: Specifies the settings for each trail.
* CloudWatchLogsLogGroupArn String
* CloudWatchLogsRoleArn String
* EnableLogFileValidation Boolean
* IncludeGlobalServiceEvents Boolean
* IsMultiRegionTrail Boolean
* KmsKeyId String
* Name required String
* S3BucketName required String
* S3KeyPrefix String
* SnsTopicName String$3
* CreateTrailResponse object: Returns the objects or data listed below if successful. Otherwise, returns an error.
* CloudWatchLogsLogGroupArn String
* CloudWatchLogsRoleArn String
* IncludeGlobalServiceEvents Boolean
* IsMultiRegionTrail Boolean
* KmsKeyId String
* LogFileValidationEnabled Boolean
* Name String
* S3BucketName String
* S3KeyPrefix String
* SnsTopicARN String
* SnsTopicName String
* TrailARN String$3
* DataResource object: 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 250 S3 buckets and object prefixes for a trail.
Example
-
You create an event selector for a trail and specify an S3 bucket and an empty prefix, such as arn:aws:s3:::bucket-1/.
-
You upload an image file to bucket-1.
-
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.
-
You upload another image file to a different S3 bucket named arn:aws:s3:::bucket-2.
-
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.
* Type String
* Values DataResourceValues$3
* DataResourceValues array
* items String$3
* DataResources
* items DataResource$3
* Date $3
* DeleteTrailRequest : The request that specifies the name of a trail to delete.
* Name required String$3
* DeleteTrailResponse object: Returns the objects or data listed below if successful. Otherwise, returns an error.$3
* DescribeTrailsRequest object: Returns information about the trail.
* includeShadowTrails Boolean
* trailNameList TrailNameList$3
* DescribeTrailsResponse object: Returns the objects or data listed below if successful. Otherwise, returns an error.
* trailList TrailList$3
* Event object: Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.
* CloudTrailEvent String
* EventId String
* EventName String
* EventSource String
* EventTime Date
* Resources ResourceList
* Username String$3
* EventSelector object: 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 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.
* DataResources DataResources
* IncludeManagementEvents Boolean
* ReadWriteType ReadWriteType$3
* EventSelectors array
* items EventSelector$3
* EventsList
* items Event$3
* GetEventSelectorsRequest
* TrailName required String$3
* GetEventSelectorsResponse
* EventSelectors EventSelectors
* TrailARN String$3
* GetTrailStatusRequest : The name of a trail about which you want the current status.
* Name required String$3
* GetTrailStatusResponse object: Returns the objects or data listed below if successful. Otherwise, returns an error.
* IsLogging Boolean
* LatestCloudWatchLogsDeliveryError String
* LatestCloudWatchLogsDeliveryTime Date
* LatestDeliveryAttemptSucceeded String
* LatestDeliveryAttemptTime String
* LatestDeliveryError String
* LatestDeliveryTime Date
* LatestDigestDeliveryError String
* LatestDigestDeliveryTime Date
* LatestNotificationAttemptSucceeded String
* LatestNotificationAttemptTime String
* LatestNotificationError String
* LatestNotificationTime Date
* StartLoggingTime Date
* StopLoggingTime Date
* TimeLoggingStarted String
* TimeLoggingStopped String$3
* InsufficientEncryptionPolicyException object: This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.$3
* InsufficientS3BucketPolicyException object: This exception is thrown when the policy on the S3 bucket is not sufficient.$3
* InsufficientSnsTopicPolicyException object: This exception is thrown when the policy on the SNS topic is not sufficient.$3
* InvalidCloudWatchLogsLogGroupArnException object: This exception is thrown when the provided CloudWatch log group is not valid.$3
* InvalidCloudWatchLogsRoleArnException object: This exception is thrown when the provided role is not valid.$3
* InvalidEventSelectorsException object: This exception is thrown when the PutEventSelectors operation is called with an invalid number of event selectors, data resources, or an invalid value for a parameter:
-
Specify a valid number of event selectors (1 to 5) for a trail.
-
Specify a valid number of data resources (1 to 250) for an event selector.
-
Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is invalid.
$3
* InvalidHomeRegionException object: This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.$3
* InvalidKmsKeyIdException object: This exception is thrown when the KMS key ARN is invalid.$3
* InvalidLookupAttributesException object: Occurs when an invalid lookup attribute is specified.$3
* InvalidMaxResultsException object: This exception is thrown if the limit specified is invalid.$3
* InvalidNextTokenException object: Invalid token or token that was previously used in a request with different parameters. This exception is thrown if the token is invalid.$3
* InvalidParameterCombinationException object: This exception is thrown when the combination of parameters provided is not valid.$3
* InvalidS3BucketNameException object: This exception is thrown when the provided S3 bucket name is not valid.$3
* InvalidS3PrefixException object: This exception is thrown when the provided S3 prefix is not valid.$3
* InvalidSnsTopicNameException object: This exception is thrown when the provided SNS topic name is not valid.$3
InvalidTagParameterException object: This exception is thrown when the key or value specified for the tag does not match the regular expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@])$.$3
* InvalidTimeRangeException object: Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values.$3
* InvalidTokenException object: Reserved for future use.$3
* InvalidTrailNameException object: This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.
-
Not be in IP address format (for example, 192.168.5.4)
$3
* KmsException object: This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.$3
* KmsKeyDisabledException object: This exception is deprecated.$3
* KmsKeyNotFoundException object: This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region.$3
* ListPublicKeysRequest object: Requests the public keys for a specified time range.
* EndTime Date
* NextToken String
* StartTime Date$3
* ListPublicKeysResponse object: Returns the objects or data listed below if successful. Otherwise, returns an error.
* NextToken String
* PublicKeyList PublicKeyList$3
* ListTagsRequest object: Specifies a list of trail tags to return.
* NextToken String
* ResourceIdList required ResourceIdList$3
* ListTagsResponse object: Returns the objects or data listed below if successful. Otherwise, returns an error.
* NextToken String
* ResourceTagList ResourceTagList$3
* LookupAttribute object: Specifies an attribute and value that filter the events returned.
* AttributeKey required LookupAttributeKey
* AttributeValue required String$3
* LookupAttributeKey string (values: EventId, EventName, Username, ResourceType, ResourceName, EventSource)$3
* LookupAttributesList array
* items LookupAttribute$3
* LookupEventsRequest : Contains a request for LookupEvents.
* EndTime Date
* LookupAttributes LookupAttributesList
* MaxResults MaxResults
* NextToken NextToken
* StartTime Date$3
* LookupEventsResponse object: Contains a response to a LookupEvents action.
* Events EventsList
* NextToken NextToken$3
* MaxResults integer$3
* MaximumNumberOfTrailsExceededException : This exception is thrown when the maximum number of trails is reached.$3
* NextToken string$3
* OperationNotPermittedException : This exception is thrown when the requested operation is not permitted.$3
* PublicKey object: Contains information about a returned public key.
* Fingerprint String
* ValidityEndTime Date
* ValidityStartTime Date
* Value ByteBuffer$3
* PublicKeyList array
* items PublicKey$3
* PutEventSelectorsRequest
* EventSelectors required EventSelectors
* TrailName required String$3
* PutEventSelectorsResponse
* EventSelectors EventSelectors
* TrailARN String$3
* ReadWriteType (values: ReadOnly, WriteOnly, All)$3
* RemoveTagsRequest object: Specifies the tags to remove from a trail.
* ResourceId required String
* TagsList TagsList$3
* RemoveTagsResponse object: Returns the objects or data listed below if successful. Otherwise, returns an error.$3
* Resource object: Specifies the type and name of a resource referenced by an event.
* ResourceName String
* ResourceType String$3
* ResourceIdList array
* items String$3
* ResourceList : A list of resources referenced by the event returned.
* items Resource$3
* ResourceNotFoundException object: This exception is thrown when the specified resource is not found.$3
* ResourceTag object: A resource tag.
* ResourceId String
* TagsList TagsList$3
* ResourceTagList array
* items ResourceTag$3
* ResourceTypeNotSupportedException : This exception is thrown when the specified resource type is not supported by CloudTrail.$3
* S3BucketDoesNotExistException object: This exception is thrown when the specified S3 bucket does not exist.$3
* StartLoggingRequest object: The request to CloudTrail to start logging AWS API calls for an account.
* Name required String$3
* StartLoggingResponse object: Returns the objects or data listed below if successful. Otherwise, returns an error.$3
* StopLoggingRequest object: Passes the request to CloudTrail to stop logging AWS API calls for the specified account.
* Name required String$3
* StopLoggingResponse object: Returns the objects or data listed below if successful. Otherwise, returns an error.$3
* String string$3
* Tag : A custom key-value pair associated with a resource such as a CloudTrail trail.
* Key required String
* Value String$3
* TagsLimitExceededException object: The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.$3
* TagsList array: A list of tags.
* items Tag$3
* Trail object: The settings for a trail.
* CloudWatchLogsLogGroupArn String
* CloudWatchLogsRoleArn String
* HasCustomEventSelectors Boolean
* HomeRegion String
* IncludeGlobalServiceEvents Boolean
* IsMultiRegionTrail Boolean
* KmsKeyId String
* LogFileValidationEnabled Boolean
* Name String
* S3BucketName String
* S3KeyPrefix String
* SnsTopicARN String
* SnsTopicName String
* TrailARN String$3
* TrailAlreadyExistsException object: This exception is thrown when the specified trail already exists.$3
* TrailList array
* items Trail$3
* TrailNameList
* items String$3
* TrailNotFoundException : This exception is thrown when the trail with the given name is not found.$3
* TrailNotProvidedException object: This exception is deprecated.$3
* UnsupportedOperationException object: This exception is thrown when the requested operation is not supported.$3
* UpdateTrailRequest object: Specifies settings to update for the trail.
* CloudWatchLogsLogGroupArn String
* CloudWatchLogsRoleArn String
* EnableLogFileValidation Boolean
* IncludeGlobalServiceEvents Boolean
* IsMultiRegionTrail Boolean
* KmsKeyId String
* Name required String
* S3BucketName String
* S3KeyPrefix String
* SnsTopicName String$3
* UpdateTrailResponse object`: Returns the objects or data listed below if successful. Otherwise, returns an error.