@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSCloudTrail extends Object implements AWSCloudTrail
AWSCloudTrail. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AddTagsResult |
addTags(AddTagsRequest request)
Adds one or more tags to a trail, up to a limit of 50.
|
CreateTrailResult |
createTrail(CreateTrailRequest request)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
DeleteTrailResult |
deleteTrail(DeleteTrailRequest request)
Deletes a trail.
|
DescribeTrailsResult |
describeTrails()
Simplified method form for invoking the DescribeTrails operation.
|
DescribeTrailsResult |
describeTrails(DescribeTrailsRequest request)
Retrieves settings for one or more trails associated with the current region for your account.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetEventSelectorsResult |
getEventSelectors(GetEventSelectorsRequest request)
Describes the settings for the event selectors that you configured for your trail.
|
GetInsightSelectorsResult |
getInsightSelectors(GetInsightSelectorsRequest request)
Describes the settings for the Insights event selectors that you configured for your trail.
|
GetTrailResult |
getTrail(GetTrailRequest request)
Returns settings information for a specified trail.
|
GetTrailStatusResult |
getTrailStatus(GetTrailStatusRequest request)
Returns a JSON-formatted list of information about the specified trail.
|
ListPublicKeysResult |
listPublicKeys()
Simplified method form for invoking the ListPublicKeys operation.
|
ListPublicKeysResult |
listPublicKeys(ListPublicKeysRequest request)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
ListTagsResult |
listTags(ListTagsRequest request)
Lists the tags for the trail in the current region.
|
ListTrailsResult |
listTrails(ListTrailsRequest request)
Lists trails that are in the current account.
|
LookupEventsResult |
lookupEvents()
Simplified method form for invoking the LookupEvents operation.
|
LookupEventsResult |
lookupEvents(LookupEventsRequest request)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
PutEventSelectorsResult |
putEventSelectors(PutEventSelectorsRequest request)
Configures an event selector or advanced event selectors for your trail.
|
PutInsightSelectorsResult |
putInsightSelectors(PutInsightSelectorsRequest request)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest request)
Removes the specified tags from a trail.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("cloudtrail.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSCloudTrail.setEndpoint(String), sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartLoggingResult |
startLogging(StartLoggingRequest request)
Starts the recording of AWS API calls and log file delivery for a trail.
|
StopLoggingResult |
stopLogging(StopLoggingRequest request)
Suspends the recording of AWS API calls and log file delivery for the specified trail.
|
UpdateTrailResult |
updateTrail(UpdateTrailRequest request)
Updates the settings that specify delivery of log files.
|
public void setEndpoint(String endpoint)
AWSCloudTrail
Callers can pass in just the endpoint (ex: "cloudtrail.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "cloudtrail.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol
from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AWSCloudTrailendpoint - The endpoint (ex: "cloudtrail.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"cloudtrail.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSCloudTrailAWSCloudTrail.setEndpoint(String), sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AWSCloudTrailregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public AddTagsResult addTags(AddTagsRequest request)
AWSCloudTrailAdds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. 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 AWS Regions only from the Region in which the trail was created (also known as its home region).
addTags in interface AWSCloudTrailrequest - Specifies the tags to add to a trail.public CreateTrailResult createTrail(CreateTrailRequest request)
AWSCloudTrailCreates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
createTrail in interface AWSCloudTrailrequest - Specifies the settings for each trail.public DeleteTrailResult deleteTrail(DeleteTrailRequest request)
AWSCloudTrail
Deletes a trail. This operation must be called from the region in which the trail was created.
DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail
that is enabled in all regions.
deleteTrail in interface AWSCloudTrailrequest - The request that specifies the name of a trail to delete.public DescribeTrailsResult describeTrails(DescribeTrailsRequest request)
AWSCloudTrailRetrieves settings for one or more trails associated with the current region for your account.
describeTrails in interface AWSCloudTrailrequest - Returns information about the trail.public DescribeTrailsResult describeTrails()
AWSCloudTraildescribeTrails in interface AWSCloudTrailAWSCloudTrail.describeTrails(DescribeTrailsRequest)public GetEventSelectorsResult getEventSelectors(GetEventSelectorsRequest request)
AWSCloudTrailDescribes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events.
For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
getEventSelectors in interface AWSCloudTrailpublic GetInsightSelectorsResult getInsightSelectors(GetInsightSelectorsRequest request)
AWSCloudTrail
Describes the settings for the Insights event selectors that you configured for your trail.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it
is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException
For more information, see Logging CloudTrail Insights Events for Trails in the AWS CloudTrail User Guide.
getInsightSelectors in interface AWSCloudTrailpublic GetTrailResult getTrail(GetTrailRequest request)
AWSCloudTrailReturns settings information for a specified trail.
getTrail in interface AWSCloudTrailpublic GetTrailStatusResult getTrailStatus(GetTrailStatusRequest request)
AWSCloudTrailReturns 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.
getTrailStatus in interface AWSCloudTrailrequest - The name of a trail about which you want the current status.public ListPublicKeysResult listPublicKeys(ListPublicKeysRequest request)
AWSCloudTrailReturns 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.
listPublicKeys in interface AWSCloudTrailrequest - Requests the public keys for a specified time range.public ListPublicKeysResult listPublicKeys()
AWSCloudTraillistPublicKeys in interface AWSCloudTrailAWSCloudTrail.listPublicKeys(ListPublicKeysRequest)public ListTagsResult listTags(ListTagsRequest request)
AWSCloudTrailLists the tags for the trail in the current region.
listTags in interface AWSCloudTrailrequest - Specifies a list of trail tags to return.public ListTrailsResult listTrails(ListTrailsRequest request)
AWSCloudTrailLists trails that are in the current account.
listTrails in interface AWSCloudTrailpublic LookupEventsResult lookupEvents(LookupEventsRequest request)
AWSCloudTrailLooks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:
AWS access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, 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 two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
lookupEvents in interface AWSCloudTrailrequest - Contains a request for LookupEvents.public LookupEventsResult lookupEvents()
AWSCloudTraillookupEvents in interface AWSCloudTrailAWSCloudTrail.lookupEvents(LookupEventsRequest)public PutEventSelectorsResult putEventSelectors(PutEventSelectorsRequest request)
AWSCloudTrailConfigures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced 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
You create an event selector for a trail and specify that you want write-only events.
The EC2 GetConsoleOutput and RunInstances API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput is a read-only event that 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 exception is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging data and management events for trails and Quotas in AWS CloudTrail in the AWS CloudTrail User Guide.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500
values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or
EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any
existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging
data events for trails in the AWS CloudTrail User Guide.
putEventSelectors in interface AWSCloudTrailpublic PutInsightSelectorsResult putInsightSelectors(PutInsightSelectorsRequest request)
AWSCloudTrail
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an
empty list of insight types. In this release, only ApiCallRateInsight is supported as an Insights
selector.
putInsightSelectors in interface AWSCloudTrailpublic RemoveTagsResult removeTags(RemoveTagsRequest request)
AWSCloudTrailRemoves the specified tags from a trail.
removeTags in interface AWSCloudTrailrequest - Specifies the tags to remove from a trail.public StartLoggingResult startLogging(StartLoggingRequest request)
AWSCloudTrailStarts 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 regions.
startLogging in interface AWSCloudTrailrequest - The request to CloudTrail to start logging AWS API calls for an account.public StopLoggingResult stopLogging(StopLoggingRequest request)
AWSCloudTrail
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 InvalidHomeRegionException will occur. This operation cannot be called
on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.
stopLogging in interface AWSCloudTrailrequest - Passes the request to CloudTrail to stop logging AWS API calls for the specified account.public UpdateTrailResult updateTrail(UpdateTrailRequest request)
AWSCloudTrail
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.
updateTrail in interface AWSCloudTrailrequest - Specifies settings to update for the trail.public void shutdown()
AWSCloudTrailshutdown in interface AWSCloudTrailpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSCloudTrailResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSCloudTrailrequest - The originally executed request.