AbstractAWSLogs (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.logs.AbstractAWSLogs

All Implemented Interfaces:

AWSLogs

Direct Known Subclasses:

AbstractAWSLogsAsync
```
public class AbstractAWSLogs
extends Object
implements AWSLogs
```
Abstract implementation of AWSLogs. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.logs.AWSLogs
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CancelExportTaskResult`	`cancelExportTask(CancelExportTaskRequest request)` Cancels the specified export task.
`CreateExportTaskResult`	`createExportTask(CreateExportTaskRequest request)` Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
`CreateLogGroupResult`	`createLogGroup(CreateLogGroupRequest request)` Creates a log group with the specified name.
`CreateLogStreamResult`	`createLogStream(CreateLogStreamRequest request)` Creates a log stream for the specified log group.
`DeleteDestinationResult`	`deleteDestination(DeleteDestinationRequest request)` Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
`DeleteLogGroupResult`	`deleteLogGroup(DeleteLogGroupRequest request)` Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
`DeleteLogStreamResult`	`deleteLogStream(DeleteLogStreamRequest request)` Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
`DeleteMetricFilterResult`	`deleteMetricFilter(DeleteMetricFilterRequest request)` Deletes the specified metric filter.
`DeleteRetentionPolicyResult`	`deleteRetentionPolicy(DeleteRetentionPolicyRequest request)` Deletes the specified retention policy.
`DeleteSubscriptionFilterResult`	`deleteSubscriptionFilter(DeleteSubscriptionFilterRequest request)` Deletes the specified subscription filter.
`DescribeDestinationsResult`	`describeDestinations()` Simplified method form for invoking the DescribeDestinations operation.
`DescribeDestinationsResult`	`describeDestinations(DescribeDestinationsRequest request)` Lists all your destinations.
`DescribeExportTasksResult`	`describeExportTasks(DescribeExportTasksRequest request)` Lists the specified export tasks.
`DescribeLogGroupsResult`	`describeLogGroups()` Simplified method form for invoking the DescribeLogGroups operation.
`DescribeLogGroupsResult`	`describeLogGroups(DescribeLogGroupsRequest request)` Lists the specified log groups.
`DescribeLogStreamsResult`	`describeLogStreams(DescribeLogStreamsRequest request)` Lists the log streams for the specified log group.
`DescribeMetricFiltersResult`	`describeMetricFilters(DescribeMetricFiltersRequest request)` Lists the specified metric filters.
`DescribeSubscriptionFiltersResult`	`describeSubscriptionFilters(DescribeSubscriptionFiltersRequest request)` Lists the subscription filters for the specified log group.
`FilterLogEventsResult`	`filterLogEvents(FilterLogEventsRequest request)` Lists log events 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)` Lists 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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSLogs
    
    Overrides the default endpoint for this client ("https://logs.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    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.
    
    Specified by:
    
    setEndpoint in interface AWSLogs
    
    Parameters:
    
    endpoint - 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.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSLogs
    
    An alternative to AWSLogs.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.
    
    Specified by:
    
    setRegion in interface AWSLogs
    
    Parameters:
    
    region - 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.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - cancelExportTask
```
public CancelExportTaskResult cancelExportTask(CancelExportTaskRequest request)
```
    Description copied from interface: AWSLogs
    
    Cancels the specified export task.
    
    The task must be in the PENDING or RUNNING state.
    
    Specified by:
    
    cancelExportTask in interface AWSLogs
    
    Returns:
    
    Result of the CancelExportTask operation returned by the service.
  - createExportTask
```
public CreateExportTaskResult createExportTask(CreateExportTaskRequest request)
```
    Description copied from interface: AWSLogs
    
    Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
    
    This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.
    
    You can export logs from multiple log groups or multiple time ranges to the same 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.
    
    Specified by:
    
    createExportTask in interface AWSLogs
    
    Returns:
    
    Result of the CreateExportTask operation returned by the service.
  - createLogGroup
```
public CreateLogGroupResult createLogGroup(CreateLogGroupRequest request)
```
    Description copied from interface: AWSLogs
    Creates a log group with the specified name.
    
    You can create up to 5000 log groups per account.
    
    You must use the following guidelines when naming a log group:
    - Log group names must be unique within a region for an AWS account.
    - Log group names can be between 1 and 512 characters long.
    - Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
    Specified by:
    
    createLogGroup in interface AWSLogs
    
    Returns:
    
    Result of the CreateLogGroup operation returned by the service.
  - createLogStream
```
public CreateLogStreamResult createLogStream(CreateLogStreamRequest request)
```
    Description copied from interface: AWSLogs
    Creates a log stream for the specified log group.
    
    There is no limit on the number of log streams that you can create for a log group.
    
    You must use the following guidelines when naming a log stream:
    - Log stream names must be unique within the log group.
    - Log stream names can be between 1 and 512 characters long.
    - The ':' (colon) and '*' (asterisk) characters are not allowed.
    Specified by:
    
    createLogStream in interface AWSLogs
    
    Returns:
    
    Result of the CreateLogStream operation returned by the service.
  - deleteDestination
```
public DeleteDestinationResult deleteDestination(DeleteDestinationRequest request)
```
    Description copied from interface: AWSLogs
    
    Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.
    
    Specified by:
    
    deleteDestination in interface AWSLogs
    
    Returns:
    
    Result of the DeleteDestination operation returned by the service.
  - deleteLogGroup
```
public DeleteLogGroupResult deleteLogGroup(DeleteLogGroupRequest request)
```
    Description copied from interface: AWSLogs
    
    Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
    
    Specified by:
    
    deleteLogGroup in interface AWSLogs
    
    Returns:
    
    Result of the DeleteLogGroup operation returned by the service.
  - deleteLogStream
```
public DeleteLogStreamResult deleteLogStream(DeleteLogStreamRequest request)
```
    Description copied from interface: AWSLogs
    
    Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
    
    Specified by:
    
    deleteLogStream in interface AWSLogs
    
    Returns:
    
    Result of the DeleteLogStream operation returned by the service.
  - deleteMetricFilter
```
public DeleteMetricFilterResult deleteMetricFilter(DeleteMetricFilterRequest request)
```
    Description copied from interface: AWSLogs
    
    Deletes the specified metric filter.
    
    Specified by:
    
    deleteMetricFilter in interface AWSLogs
    
    Returns:
    
    Result of the DeleteMetricFilter operation returned by the service.
  - deleteRetentionPolicy
```
public DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
```
    Description copied from interface: AWSLogs
    
    Deletes the specified retention policy.
    
    Log events do not expire if they belong to log groups without a retention policy.
    
    Specified by:
    
    deleteRetentionPolicy in interface AWSLogs
    
    Returns:
    
    Result of the DeleteRetentionPolicy operation returned by the service.
  - deleteSubscriptionFilter
```
public DeleteSubscriptionFilterResult deleteSubscriptionFilter(DeleteSubscriptionFilterRequest request)
```
    Description copied from interface: AWSLogs
    
    Deletes the specified subscription filter.
    
    Specified by:
    
    deleteSubscriptionFilter in interface AWSLogs
    
    Returns:
    
    Result of the DeleteSubscriptionFilter operation returned by the service.
  - describeDestinations
```
public DescribeDestinationsResult describeDestinations(DescribeDestinationsRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists all your destinations. The results are ASCII-sorted by destination name.
    
    Specified by:
    
    describeDestinations in interface AWSLogs
    
    Returns:
    
    Result of the DescribeDestinations operation returned by the service.
  - describeDestinations
```
public DescribeDestinationsResult describeDestinations()
```
    Description copied from interface: AWSLogs
    
    Simplified method form for invoking the DescribeDestinations operation.
    
    Specified by:
    
    describeDestinations in interface AWSLogs
    
    See Also:
    
    AWSLogs.describeDestinations(DescribeDestinationsRequest)
  - describeExportTasks
```
public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
    
    Specified by:
    
    describeExportTasks in interface AWSLogs
    
    Returns:
    
    Result of the DescribeExportTasks operation returned by the service.
  - describeLogGroups
```
public DescribeLogGroupsResult describeLogGroups(DescribeLogGroupsRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
    
    Specified by:
    
    describeLogGroups in interface AWSLogs
    
    Returns:
    
    Result of the DescribeLogGroups operation returned by the service.
  - describeLogGroups
```
public DescribeLogGroupsResult describeLogGroups()
```
    Description copied from interface: AWSLogs
    
    Simplified method form for invoking the DescribeLogGroups operation.
    
    Specified by:
    
    describeLogGroups in interface AWSLogs
    
    See Also:
    
    AWSLogs.describeLogGroups(DescribeLogGroupsRequest)
  - describeLogStreams
```
public DescribeLogStreamsResult describeLogStreams(DescribeLogStreamsRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
    
    This operation has a limit of five transactions per second, after which transactions are throttled.
    
    Specified by:
    
    describeLogStreams in interface AWSLogs
    
    Returns:
    
    Result of the DescribeLogStreams operation returned by the service.
  - describeMetricFilters
```
public DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
    
    Specified by:
    
    describeMetricFilters in interface AWSLogs
    
    Returns:
    
    Result of the DescribeMetricFilters operation returned by the service.
  - describeSubscriptionFilters
```
public DescribeSubscriptionFiltersResult describeSubscriptionFilters(DescribeSubscriptionFiltersRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.
    
    Specified by:
    
    describeSubscriptionFilters in interface AWSLogs
    
    Returns:
    
    Result of the DescribeSubscriptionFilters operation returned by the service.
  - filterLogEvents
```
public FilterLogEventsResult filterLogEvents(FilterLogEventsRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.
    
    By default, this operation returns as many log events as can fit in 1MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.
    
    Specified by:
    
    filterLogEvents in interface AWSLogs
    
    Returns:
    
    Result of the FilterLogEvents operation returned by the service.
  - getLogEvents
```
public GetLogEventsResult getLogEvents(GetLogEventsRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists log events from the specified log stream. You can list all the log events or filter using a time range.
    
    By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). If the results include tokens, there are more log events available. You can get additional log events by specifying one of the tokens in a subsequent call.
    
    Specified by:
    
    getLogEvents in interface AWSLogs
    
    Returns:
    
    Result of the GetLogEvents operation returned by the service.
  - putDestination
```
public PutDestinationResult putDestination(PutDestinationRequest request)
```
    Description copied from interface: AWSLogs
    
    Creates or updates a destination. A destination encapsulates a physical resource (such as a Kinesis stream) and enables you to subscribe to a real-time stream of log events of a different account, ingested using PutLogEvents. 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 cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.
    
    Specified by:
    
    putDestination in interface AWSLogs
    
    Returns:
    
    Result of the PutDestination operation returned by the service.
  - putDestinationPolicy
```
public PutDestinationPolicyResult putDestinationPolicy(PutDestinationPolicyRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    putDestinationPolicy in interface AWSLogs
    
    Returns:
    
    Result of the PutDestinationPolicy operation returned by the service.
  - putLogEvents
```
public PutLogEventsResult putLogEvents(PutLogEventsRequest request)
```
    Description copied from interface: AWSLogs
    Uploads a batch of log events to the specified log stream.
    
    You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams.
    
    The batch of events must satisfy the following constraints:
    - The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
    - None of the log events in the batch can be more than 2 hours in the future.
    - None of the log events in the batch can be older than 14 days or the retention period of the log group.
    - The log events in the batch must be in chronological ordered by their timestamp.
    - The maximum number of log events in a batch is 10,000.
    - A batch of log events in a single PutLogEvents request cannot span more than 24 hours. Otherwise, the PutLogEvents operation will fail.
    Specified by:
    
    putLogEvents in interface AWSLogs
    
    Returns:
    
    Result of the PutLogEvents operation returned by the service.
  - putMetricFilter
```
public PutMetricFilterResult putMetricFilter(PutMetricFilterRequest request)
```
    Description copied from interface: 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.
    
    The maximum number of metric filters that can be associated with a log group is 100.
    
    Specified by:
    
    putMetricFilter in interface AWSLogs
    
    Returns:
    
    Result of the PutMetricFilter operation returned by the service.
  - putRetentionPolicy
```
public PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest request)
```
    Description copied from interface: AWSLogs
    
    Sets 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.
    
    Specified by:
    
    putRetentionPolicy in interface AWSLogs
    
    Returns:
    
    Result of the PutRetentionPolicy operation returned by the service.
  - putSubscriptionFilter
```
public PutSubscriptionFilterResult putSubscriptionFilter(PutSubscriptionFilterRequest request)
```
    Description copied from interface: 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 and have them delivered to a specific destination. Currently, the supported destinations are:
    - An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
    - A logical destination that belongs to a different account, for cross-account delivery.
    - An Amazon Kinesis Firehose stream that belongs to the same account as the subscription filter, for same-account delivery.
    - An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
    There can only be one subscription filter associated with a log group.
    Specified by:
    
    putSubscriptionFilter in interface AWSLogs
    
    Returns:
    
    Result of the PutSubscriptionFilter operation returned by the service.
  - testMetricFilter
```
public TestMetricFilterResult testMetricFilter(TestMetricFilterRequest request)
```
    Description copied from interface: AWSLogs
    
    Tests 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.
    
    Specified by:
    
    testMetricFilter in interface AWSLogs
    
    Returns:
    
    Result of the TestMetricFilter operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSLogs
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSLogs
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSLogs
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response 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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSLogs
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSLogs

Field Summary

Fields inherited from interface com.amazonaws.services.logs.AWSLogs

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

cancelExportTask

createExportTask

createLogGroup

createLogStream

deleteDestination

deleteLogGroup

deleteLogStream

deleteMetricFilter

deleteRetentionPolicy

deleteSubscriptionFilter

describeDestinations

describeDestinations

describeExportTasks

describeLogGroups

describeLogGroups

describeLogStreams

describeMetricFilters

describeSubscriptionFilters

filterLogEvents

getLogEvents

putDestination

putDestinationPolicy

putLogEvents

putMetricFilter

putRetentionPolicy

putSubscriptionFilter

testMetricFilter

shutdown

getCachedResponseMetadata