AWSLogs (AWS Java SDK for Amazon CloudWatch Logs 1.11.119 API)

All Known Subinterfaces:

AWSLogsAsync

All Known Implementing Classes:

AbstractAWSLogs, AbstractAWSLogsAsync, AWSLogsAsyncClient, AWSLogsClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSLogs
```
Interface for accessing Amazon CloudWatch Logs.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSLogs instead.

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK.

You can use CloudWatch Logs to:
- Monitor Logs from Amazon EC2 Instances in Real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify.
- Monitor Amazon CloudTrail Logged Events: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.
- Archive Log Data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`CancelExportTaskResult`	`cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)` Cancels the specified export task.
`CreateExportTaskResult`	`createExportTask(CreateExportTaskRequest createExportTaskRequest)` Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
`CreateLogGroupResult`	`createLogGroup(CreateLogGroupRequest createLogGroupRequest)` Creates a log group with the specified name.
`CreateLogStreamResult`	`createLogStream(CreateLogStreamRequest createLogStreamRequest)` Creates a log stream for the specified log group.
`DeleteDestinationResult`	`deleteDestination(DeleteDestinationRequest deleteDestinationRequest)` Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
`DeleteLogGroupResult`	`deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest)` Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
`DeleteLogStreamResult`	`deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest)` Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
`DeleteMetricFilterResult`	`deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest)` Deletes the specified metric filter.
`DeleteRetentionPolicyResult`	`deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)` Deletes the specified retention policy.
`DeleteSubscriptionFilterResult`	`deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)` Deletes the specified subscription filter.
`DescribeDestinationsResult`	`describeDestinations()` Simplified method form for invoking the DescribeDestinations operation.
`DescribeDestinationsResult`	`describeDestinations(DescribeDestinationsRequest describeDestinationsRequest)` Lists all your destinations.
`DescribeExportTasksResult`	`describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)` Lists the specified export tasks.
`DescribeLogGroupsResult`	`describeLogGroups()` Simplified method form for invoking the DescribeLogGroups operation.
`DescribeLogGroupsResult`	`describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest)` Lists the specified log groups.
`DescribeLogStreamsResult`	`describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest)` Lists the log streams for the specified log group.
`DescribeMetricFiltersResult`	`describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest)` Lists the specified metric filters.
`DescribeSubscriptionFiltersResult`	`describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)` Lists the subscription filters for the specified log group.
`FilterLogEventsResult`	`filterLogEvents(FilterLogEventsRequest filterLogEventsRequest)` 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 getLogEventsRequest)` Lists log events from the specified log stream.
`ListTagsLogGroupResult`	`listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest)` Lists the tags for the specified log group.
`PutDestinationResult`	`putDestination(PutDestinationRequest putDestinationRequest)` Creates or updates a destination.
`PutDestinationPolicyResult`	`putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest)` Creates or updates an access policy associated with an existing destination.
`PutLogEventsResult`	`putLogEvents(PutLogEventsRequest putLogEventsRequest)` Uploads a batch of log events to the specified log stream.
`PutMetricFilterResult`	`putMetricFilter(PutMetricFilterRequest putMetricFilterRequest)` Creates or updates a metric filter and associates it with the specified log group.
`PutRetentionPolicyResult`	`putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)` Sets the retention of the specified log group.
`PutSubscriptionFilterResult`	`putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest)` Creates or updates a subscription filter and associates it with the specified log group.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagLogGroupResult`	`tagLogGroup(TagLogGroupRequest tagLogGroupRequest)` Adds or updates the specified tags for the specified log group.
`TestMetricFilterResult`	`testMetricFilter(TestMetricFilterRequest testMetricFilterRequest)` Tests the filter pattern of a metric filter against a sample of log event messages.
`UntagLogGroupResult`	`untagLogGroup(UntagLogGroupRequest untagLogGroupRequest)` Removes the specified tags from the specified log group.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    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.
    
    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
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to 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.
    
    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
```
CancelExportTaskResult cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)
```
    Cancels the specified export task.
    
    The task must be in the PENDING or RUNNING state.
    
    Parameters:
    
    cancelExportTaskRequest -
    
    Returns:
    
    Result of the CancelExportTask operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    InvalidOperationException - The operation is not valid on the specified resource.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - createExportTask
```
CreateExportTaskResult createExportTask(CreateExportTaskRequest createExportTaskRequest)
```
    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.
    
    Parameters:
    
    createExportTaskRequest -
    
    Returns:
    
    Result of the CreateExportTask operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    LimitExceededException - You have reached the maximum number of resources that can be created.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    See Also:
    
    AWS API Documentation
  - createLogGroup
```
CreateLogGroupResult createLogGroup(CreateLogGroupRequest createLogGroupRequest)
```
    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).
    Parameters:
    
    createLogGroupRequest -
    
    Returns:
    
    Result of the CreateLogGroup operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    LimitExceededException - You have reached the maximum number of resources that can be created.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - createLogStream
```
CreateLogStreamResult createLogStream(CreateLogStreamRequest createLogStreamRequest)
```
    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.
    Parameters:
    
    createLogStreamRequest -
    
    Returns:
    
    Result of the CreateLogStream operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - deleteDestination
```
DeleteDestinationResult deleteDestination(DeleteDestinationRequest deleteDestinationRequest)
```
    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.
    
    Parameters:
    
    deleteDestinationRequest -
    
    Returns:
    
    Result of the DeleteDestination operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - deleteLogGroup
```
DeleteLogGroupResult deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest)
```
    Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
    
    Parameters:
    
    deleteLogGroupRequest -
    
    Returns:
    
    Result of the DeleteLogGroup operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - deleteLogStream
```
DeleteLogStreamResult deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest)
```
    Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
    
    Parameters:
    
    deleteLogStreamRequest -
    
    Returns:
    
    Result of the DeleteLogStream operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - deleteMetricFilter
```
DeleteMetricFilterResult deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest)
```
    Deletes the specified metric filter.
    
    Parameters:
    
    deleteMetricFilterRequest -
    
    Returns:
    
    Result of the DeleteMetricFilter operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - deleteRetentionPolicy
```
DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
```
    Deletes the specified retention policy.
    
    Log events do not expire if they belong to log groups without a retention policy.
    
    Parameters:
    
    deleteRetentionPolicyRequest -
    
    Returns:
    
    Result of the DeleteRetentionPolicy operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - deleteSubscriptionFilter
```
DeleteSubscriptionFilterResult deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)
```
    Deletes the specified subscription filter.
    
    Parameters:
    
    deleteSubscriptionFilterRequest -
    
    Returns:
    
    Result of the DeleteSubscriptionFilter operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - describeDestinations
```
DescribeDestinationsResult describeDestinations(DescribeDestinationsRequest describeDestinationsRequest)
```
    Lists all your destinations. The results are ASCII-sorted by destination name.
    
    Parameters:
    
    describeDestinationsRequest -
    
    Returns:
    
    Result of the DescribeDestinations operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - describeDestinations
```
DescribeDestinationsResult describeDestinations()
```
    Simplified method form for invoking the DescribeDestinations operation.
    
    See Also:
    
    describeDestinations(DescribeDestinationsRequest)
  - describeExportTasks
```
DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest)
```
    Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
    
    Parameters:
    
    describeExportTasksRequest -
    
    Returns:
    
    Result of the DescribeExportTasks operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - describeLogGroups
```
DescribeLogGroupsResult describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest)
```
    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.
    
    Parameters:
    
    describeLogGroupsRequest -
    
    Returns:
    
    Result of the DescribeLogGroups operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - describeLogGroups
```
DescribeLogGroupsResult describeLogGroups()
```
    Simplified method form for invoking the DescribeLogGroups operation.
    
    See Also:
    
    describeLogGroups(DescribeLogGroupsRequest)
  - describeLogStreams
```
DescribeLogStreamsResult describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest)
```
    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.
    
    Parameters:
    
    describeLogStreamsRequest -
    
    Returns:
    
    Result of the DescribeLogStreams operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - describeMetricFilters
```
DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest)
```
    Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, and metric namespace. The results are ASCII-sorted by filter name.
    
    Parameters:
    
    describeMetricFiltersRequest -
    
    Returns:
    
    Result of the DescribeMetricFilters operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - describeSubscriptionFilters
```
DescribeSubscriptionFiltersResult describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest)
```
    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.
    
    Parameters:
    
    describeSubscriptionFiltersRequest -
    
    Returns:
    
    Result of the DescribeSubscriptionFilters operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - filterLogEvents
```
FilterLogEventsResult filterLogEvents(FilterLogEventsRequest filterLogEventsRequest)
```
    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.
    
    Parameters:
    
    filterLogEventsRequest -
    
    Returns:
    
    Result of the FilterLogEvents operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - getLogEvents
```
GetLogEventsResult getLogEvents(GetLogEventsRequest getLogEventsRequest)
```
    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.
    
    Parameters:
    
    getLogEventsRequest -
    
    Returns:
    
    Result of the GetLogEvents operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - listTagsLogGroup
```
ListTagsLogGroupResult listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest)
```
    Lists the tags for the specified log group.
    
    To add tags, use TagLogGroup. To remove tags, use UntagLogGroup.
    
    Parameters:
    
    listTagsLogGroupRequest -
    
    Returns:
    
    Result of the ListTagsLogGroup operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource does not exist.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - putDestination
```
PutDestinationResult putDestination(PutDestinationRequest putDestinationRequest)
```
    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.
    
    Parameters:
    
    putDestinationRequest -
    
    Returns:
    
    Result of the PutDestination operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - putDestinationPolicy
```
PutDestinationPolicyResult putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest)
```
    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.
    
    Parameters:
    
    putDestinationPolicyRequest -
    
    Returns:
    
    Result of the PutDestinationPolicy operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - putLogEvents
```
PutLogEventsResult putLogEvents(PutLogEventsRequest putLogEventsRequest)
```
    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 time the event occurred, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC).
    - The maximum number of log events in a batch is 10,000.
    - A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
    Parameters:
    
    putLogEventsRequest -
    
    Returns:
    
    Result of the PutLogEvents operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    InvalidSequenceTokenException - The sequence token is not valid.
    
    DataAlreadyAcceptedException - The event was already logged.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - putMetricFilter
```
PutMetricFilterResult putMetricFilter(PutMetricFilterRequest putMetricFilterRequest)
```
    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.
    
    Parameters:
    
    putMetricFilterRequest -
    
    Returns:
    
    Result of the PutMetricFilter operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    LimitExceededException - You have reached the maximum number of resources that can be created.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - putRetentionPolicy
```
PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest)
```
    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.
    
    Parameters:
    
    putRetentionPolicyRequest -
    
    Returns:
    
    Result of the PutRetentionPolicy operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - putSubscriptionFilter
```
PutSubscriptionFilterResult putSubscriptionFilter(PutSubscriptionFilterRequest putSubscriptionFilterRequest)
```
    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.
    Parameters:
    
    putSubscriptionFilterRequest -
    
    Returns:
    
    Result of the PutSubscriptionFilter operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ResourceNotFoundException - The specified resource does not exist.
    
    OperationAbortedException - Multiple requests to update the same resource were in conflict.
    
    LimitExceededException - You have reached the maximum number of resources that can be created.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - tagLogGroup
```
TagLogGroupResult tagLogGroup(TagLogGroupRequest tagLogGroupRequest)
```
    Adds or updates the specified tags for the specified log group.
    
    To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.
    
    For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
    
    Parameters:
    
    tagLogGroupRequest -
    
    Returns:
    
    Result of the TagLogGroup operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource does not exist.
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    See Also:
    
    AWS API Documentation
  - testMetricFilter
```
TestMetricFilterResult testMetricFilter(TestMetricFilterRequest testMetricFilterRequest)
```
    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.
    
    Parameters:
    
    testMetricFilterRequest -
    
    Returns:
    
    Result of the TestMetricFilter operation returned by the service.
    
    Throws:
    
    InvalidParameterException - A parameter is specified incorrectly.
    
    ServiceUnavailableException - The service cannot complete the request.
    
    See Also:
    
    AWS API Documentation
  - untagLogGroup
```
UntagLogGroupResult untagLogGroup(UntagLogGroupRequest untagLogGroupRequest)
```
    Removes the specified tags from the specified log group.
    
    To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.
    
    Parameters:
    
    untagLogGroupRequest -
    
    Returns:
    
    Result of the UntagLogGroup operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource does not exist.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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. 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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AWSLogs

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

cancelExportTask

createExportTask

createLogGroup

createLogStream

deleteDestination

deleteLogGroup

deleteLogStream

deleteMetricFilter

deleteRetentionPolicy

deleteSubscriptionFilter

describeDestinations

describeDestinations

describeExportTasks

describeLogGroups

describeLogGroups

describeLogStreams

describeMetricFilters

describeSubscriptionFilters

filterLogEvents

getLogEvents

listTagsLogGroup

putDestination

putDestinationPolicy

putLogEvents

putMetricFilter

putRetentionPolicy

putSubscriptionFilter

tagLogGroup

testMetricFilter

untagLogGroup

shutdown

getCachedResponseMetadata