public class AbstractAWSLogs extends Object implements AWSLogs
AWSLogs. 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 |
|---|---|
CancelExportTaskResult |
cancelExportTask(CancelExportTaskRequest request)
Cancels an export task if it is in
PENDING or
RUNNING state. |
CreateExportTaskResult |
createExportTask(CreateExportTaskRequest request)
Creates an
ExportTask which allows you to efficiently export
data from a Log Group to your Amazon S3 bucket. |
CreateLogGroupResult |
createLogGroup(CreateLogGroupRequest request)
Creates a new log group with the specified name.
|
CreateLogStreamResult |
createLogStream(CreateLogStreamRequest request)
Creates a new log stream in the specified log group.
|
DeleteDestinationResult |
deleteDestination(DeleteDestinationRequest request)
Deletes the destination with the specified name and eventually disables
all the subscription filters that publish to it.
|
DeleteLogGroupResult |
deleteLogGroup(DeleteLogGroupRequest request)
Deletes the log group with the specified name and permanently deletes all
the archived log events associated with it.
|
DeleteLogStreamResult |
deleteLogStream(DeleteLogStreamRequest request)
Deletes a log stream and permanently deletes all the archived log events
associated with it.
|
DeleteMetricFilterResult |
deleteMetricFilter(DeleteMetricFilterRequest request)
Deletes a metric filter associated with the specified log group.
|
DeleteRetentionPolicyResult |
deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
Deletes the retention policy of the specified log group.
|
DeleteSubscriptionFilterResult |
deleteSubscriptionFilter(DeleteSubscriptionFilterRequest request)
Deletes a subscription filter associated with the specified log group.
|
DescribeDestinationsResult |
describeDestinations()
Simplified method form for invoking the DescribeDestinations operation.
|
DescribeDestinationsResult |
describeDestinations(DescribeDestinationsRequest request)
Returns all the destinations that are associated with the AWS account
making the request.
|
DescribeExportTasksResult |
describeExportTasks(DescribeExportTasksRequest request)
Returns all the export tasks that are associated with the AWS account
making the request.
|
DescribeLogGroupsResult |
describeLogGroups()
Simplified method form for invoking the DescribeLogGroups operation.
|
DescribeLogGroupsResult |
describeLogGroups(DescribeLogGroupsRequest request)
Returns all the log groups that are associated with the AWS account
making the request.
|
DescribeLogStreamsResult |
describeLogStreams(DescribeLogStreamsRequest request)
Returns all the log streams that are associated with the specified log
group.
|
DescribeMetricFiltersResult |
describeMetricFilters(DescribeMetricFiltersRequest request)
Returns all the metrics filters associated with the specified log group.
|
DescribeSubscriptionFiltersResult |
describeSubscriptionFilters(DescribeSubscriptionFiltersRequest request)
Returns all the subscription filters associated with the specified log
group.
|
FilterLogEventsResult |
filterLogEvents(FilterLogEventsRequest request)
Retrieves log events, optionally filtered by a filter pattern from the
specified log group.
|
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.
|
GetLogEventsResult |
getLogEvents(GetLogEventsRequest request)
Retrieves log events from the specified log stream.
|
PutDestinationResult |
putDestination(PutDestinationRequest request)
Creates or updates a
Destination. |
PutDestinationPolicyResult |
putDestinationPolicy(PutDestinationPolicyRequest request)
Creates or updates an access policy associated with an existing
Destination. |
PutLogEventsResult |
putLogEvents(PutLogEventsRequest request)
Uploads a batch of log events to the specified log stream.
|
PutMetricFilterResult |
putMetricFilter(PutMetricFilterRequest request)
Creates or updates a metric filter and associates it with the specified
log group.
|
PutRetentionPolicyResult |
putRetentionPolicy(PutRetentionPolicyRequest request)
Sets the retention of the specified log group.
|
PutSubscriptionFilterResult |
putSubscriptionFilter(PutSubscriptionFilterRequest request)
Creates or updates a subscription filter and associates it with the
specified log group.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client
("https://logs.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSLogs.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.
|
TestMetricFilterResult |
testMetricFilter(TestMetricFilterRequest request)
Tests the filter pattern of a metric filter against a sample of log event
messages.
|
public void setEndpoint(String endpoint)
AWSLogs
Callers can pass in just the endpoint (ex:
"logs.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://logs.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 AWSLogsendpoint - The endpoint (ex: "logs.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex:
"https://logs.us-east-1.amazonaws.com") of the region specific AWS
endpoint this client will communicate with.public void setRegion(Region region)
AWSLogsAWSLogs.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 AWSLogsregion - 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 CancelExportTaskResult cancelExportTask(CancelExportTaskRequest request)
AWSLogs
Cancels an export task if it is in PENDING or
RUNNING state.
cancelExportTask in interface AWSLogspublic CreateExportTaskResult createExportTask(CreateExportTaskRequest request)
AWSLogs
Creates an ExportTask which allows you to efficiently export
data from a Log Group to your Amazon S3 bucket.
This is an asynchronous call. If all the required information is
provided, this API will initiate an export task and respond with the task
Id. Once started, DescribeExportTasks can be used to get the
status of an export task. You can only have one active (
RUNNING or PENDING) export task at a time, per
account.
You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects.
createExportTask in interface AWSLogspublic CreateLogGroupResult createLogGroup(CreateLogGroupRequest request)
AWSLogsCreates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.
You must use the following guidelines when naming a log group:
createLogGroup in interface AWSLogspublic CreateLogStreamResult createLogStream(CreateLogStreamRequest request)
AWSLogsCreates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.
You must use the following guidelines when naming a log stream:
createLogStream in interface AWSLogspublic DeleteDestinationResult deleteDestination(DeleteDestinationRequest request)
AWSLogsDeletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination.
deleteDestination in interface AWSLogspublic DeleteLogGroupResult deleteLogGroup(DeleteLogGroupRequest request)
AWSLogsDeletes the log group with the specified name and permanently deletes all the archived log events associated with it.
deleteLogGroup in interface AWSLogspublic DeleteLogStreamResult deleteLogStream(DeleteLogStreamRequest request)
AWSLogsDeletes a log stream and permanently deletes all the archived log events associated with it.
deleteLogStream in interface AWSLogspublic DeleteMetricFilterResult deleteMetricFilter(DeleteMetricFilterRequest request)
AWSLogsDeletes a metric filter associated with the specified log group.
deleteMetricFilter in interface AWSLogspublic DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
AWSLogsDeletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.
deleteRetentionPolicy in interface AWSLogspublic DeleteSubscriptionFilterResult deleteSubscriptionFilter(DeleteSubscriptionFilterRequest request)
AWSLogsDeletes a subscription filter associated with the specified log group.
deleteSubscriptionFilter in interface AWSLogspublic DescribeDestinationsResult describeDestinations(DescribeDestinationsRequest request)
AWSLogsReturns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name.
By default, this operation returns up to 50 destinations. If there are
more destinations to list, the response would contain a
nextToken value in the response body. You can
also limit the number of destinations returned in the response by
specifying the limit parameter in the request.
describeDestinations in interface AWSLogspublic DescribeDestinationsResult describeDestinations()
AWSLogsdescribeDestinations in interface AWSLogsAWSLogs.describeDestinations(DescribeDestinationsRequest)public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest request)
AWSLogs
Returns all the export tasks that are associated with the AWS account
making the request. The export tasks can be filtered based on
TaskId or TaskStatus.
By default, this operation returns up to 50 export tasks that satisfy the
specified filters. If there are more export tasks to list, the response
would contain a nextToken value in the response
body. You can also limit the number of export tasks returned in the
response by specifying the limit parameter in
the request.
describeExportTasks in interface AWSLogspublic DescribeLogGroupsResult describeLogGroups(DescribeLogGroupsRequest request)
AWSLogsReturns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.
By default, this operation returns up to 50 log groups. If there are more
log groups to list, the response would contain a
nextToken value in the response body. You can
also limit the number of log groups returned in the response by
specifying the limit parameter in the request.
describeLogGroups in interface AWSLogspublic DescribeLogGroupsResult describeLogGroups()
AWSLogsdescribeLogGroups in interface AWSLogsAWSLogs.describeLogGroups(DescribeLogGroupsRequest)public DescribeLogStreamsResult describeLogStreams(DescribeLogStreamsRequest request)
AWSLogsReturns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.
By default, this operation returns up to 50 log streams. If there are
more log streams to list, the response would contain a
nextToken value in the response body. You can
also limit the number of log streams returned in the response by
specifying the limit parameter in the request.
This operation has a limit of five transactions per second, after which
transactions are throttled.
describeLogStreams in interface AWSLogspublic DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest request)
AWSLogsReturns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.
By default, this operation returns up to 50 metric filters. If there are
more metric filters to list, the response would contain a
nextToken value in the response body. You can
also limit the number of metric filters returned in the response by
specifying the limit parameter in the request.
describeMetricFilters in interface AWSLogspublic DescribeSubscriptionFiltersResult describeSubscriptionFilters(DescribeSubscriptionFiltersRequest request)
AWSLogsReturns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.
By default, this operation returns up to 50 subscription filters. If
there are more subscription filters to list, the response would contain a
nextToken value in the response body. You can
also limit the number of subscription filters returned in the response by
specifying the limit parameter in the request.
describeSubscriptionFilters in interface AWSLogspublic FilterLogEventsResult filterLogEvents(FilterLogEventsRequest request)
AWSLogs
Retrieves log events, optionally filtered by a filter pattern from the
specified log group. You can provide an optional time range to filter the
results on the event timestamp. You can limit
the streams searched to an explicit list of
logStreamNames.
By default, this operation returns as much matching log events as can fit
in a response size of 1MB, up to 10,000 log events, or all the events
found within a time-bounded scan window. If the response includes a
nextToken, then there is more data to search,
and the search can be resumed with a new request providing the nextToken.
The response will contain a list of
searchedLogStreams that contains information
about which streams were searched in the request and whether they have
been searched completely or require further pagination. The
limit parameter in the request. can be used to
specify the maximum number of events to return in a page.
filterLogEvents in interface AWSLogspublic GetLogEventsResult getLogEvents(GetLogEventsRequest request)
AWSLogs
Retrieves log events from the specified log stream. You can provide an
optional time range to filter the results on the event
timestamp.
By default, this operation returns as much log events as can fit in a
response size of 1MB, up to 10,000 log events. The response will always
include a nextForwardToken and a
nextBackwardToken in the response body. You can
use any of these tokens in subsequent
GetLogEvents requests to paginate through
events in either forward or backward direction. You can also limit the
number of log events returned in the response by specifying the
limit parameter in the request.
getLogEvents in interface AWSLogspublic PutDestinationResult putDestination(PutDestinationRequest request)
AWSLogs
Creates or updates a Destination. A destination encapsulates
a physical resource (such as a Kinesis stream) and allows you to
subscribe to a real-time stream of log events of a different account,
ingested through PutLogEvents requests.
Currently, the only supported physical resource is a Amazon Kinesis
stream belonging to the same account as the destination.
A destination controls what is written to its Amazon Kinesis stream
through an access policy. By default, PutDestination does not set any
access policy with the destination, which means a cross-account user will
not be able to call PutSubscriptionFilter against this
destination. To enable that, the destination owner must call
PutDestinationPolicy after PutDestination.
putDestination in interface AWSLogspublic PutDestinationPolicyResult putDestinationPolicy(PutDestinationPolicyRequest request)
AWSLogs
Creates or updates an access policy associated with an existing
Destination. An access policy is an IAM policy document that is used to authorize claims to register a
subscription filter against a given destination.
putDestinationPolicy in interface AWSLogspublic PutLogEventsResult putLogEvents(PutLogEventsRequest request)
AWSLogsUploads a batch of log events to the specified log stream.
Every PutLogEvents request must include the
sequenceToken obtained from the response of the
previous request. An upload in a newly created log stream does not
require a sequenceToken.
The batch of events must satisfy the following constraints:
timestamp.putLogEvents in interface AWSLogspublic PutMetricFilterResult putMetricFilter(PutMetricFilterRequest request)
AWSLogs
Creates or updates a metric filter and associates it with the specified
log group. Metric filters allow you to configure rules to extract metric
data from log events ingested through
PutLogEvents requests.
The maximum number of metric filters that can be associated with a log group is 100.
putMetricFilter in interface AWSLogspublic PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest request)
AWSLogsSets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.
putRetentionPolicy in interface AWSLogspublic PutSubscriptionFilterResult putSubscriptionFilter(PutSubscriptionFilterRequest request)
AWSLogs
Creates or updates a subscription filter and associates it with the
specified log group. Subscription filters allow you to subscribe to a
real-time stream of log events ingested through
PutLogEvents requests and have them delivered
to a specific destination. Currently, the supported destinations are:
Destination)
belonging to a different account, for cross-account delivery.Currently there can only be one subscription filter associated with a log group.
putSubscriptionFilter in interface AWSLogspublic TestMetricFilterResult testMetricFilter(TestMetricFilterRequest request)
AWSLogsTests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.
testMetricFilter in interface AWSLogspublic void shutdown()
AWSLogspublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSLogsResponse 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 AWSLogsrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.