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.| Modifier and Type | Method and Description |
|---|---|
AddTagsResult |
addTags(AddTagsRequest request)
Adds one or more tags to a trail, up to a limit of 10.
|
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 the trail 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.
|
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 specified trail or trails in the current region.
|
LookupEventsResult |
lookupEvents()
Simplified method form for invoking the LookupEvents operation.
|
LookupEventsResult |
lookupEvents(LookupEventsRequest request)
Looks up API activity events captured by CloudTrail that create, update,
or delete resources in your account.
|
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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
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 10. 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).
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. A maximum of five trails can exist in a region, irrespective of the region in which they were created.
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 the trail 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 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.
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 specified trail or trails in the current region.
Lists the tags for the trail in the current region.
listTags in interface AWSCloudTrailrequest - Specifies a list of trail tags to return.public LookupEventsResult lookupEvents(LookupEventsRequest request)
AWSCloudTrailLooks 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 five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. 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.
lookupEvents in interface AWSCloudTrailrequest - Contains a request for LookupEvents.public LookupEventsResult lookupEvents()
AWSCloudTraillookupEvents in interface AWSCloudTrailAWSCloudTrail.lookupEvents(LookupEventsRequest)public 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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.