AWSLogsClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.logs.AWSLogsClient

All Implemented Interfaces:

AWSLogs

Direct Known Subclasses:

AWSLogsAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSLogsClient
extends AmazonWebServiceClient
implements AWSLogs
```
Client for accessing Amazon CloudWatch Logs. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.logs.AWSLogs
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AWSLogsClient()` Constructs a new client to invoke service methods on Amazon CloudWatch Logs.
`AWSLogsClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials.
`AWSLogsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials and client configuration options.
`AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials provider.
`AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials provider and client configuration options.
`AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials provider, client configuration options, and request metric collector.
`AWSLogsClient(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on Amazon CloudWatch Logs.

Method Summary

All Methods Instance Methods Concrete 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.
`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.

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

Methods inherited from interface com.amazonaws.services.logs.AWSLogs
setEndpoint, setRegion, shutdown

- Constructor Detail
  - AWSLogsClient
```
public AWSLogsClient()
```
    Constructs a new client to invoke service methods on Amazon CloudWatch Logs. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSLogsClient
```
public AWSLogsClient(ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on Amazon CloudWatch Logs. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudWatch Logs (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSLogsClient
```
public AWSLogsClient(AWSCredentials awsCredentials)
```
    Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AWSLogsClient
```
public AWSLogsClient(AWSCredentials awsCredentials,
                     ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudWatch Logs (ex: proxy settings, retry counts, etc.).
  - AWSLogsClient
```
public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AWSLogsClient
```
public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider,
                     ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudWatch Logs (ex: proxy settings, retry counts, etc.).
  - AWSLogsClient
```
public AWSLogsClient(AWSCredentialsProvider awsCredentialsProvider,
                     ClientConfiguration clientConfiguration,
                     RequestMetricCollector requestMetricCollector)
```
    Constructs a new client to invoke service methods on Amazon CloudWatch Logs using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudWatch Logs (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - cancelExportTask
```
public CancelExportTaskResult cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest)
```
    Cancels the specified export task.
    
    The task must be in the PENDING or RUNNING state.
    
    Specified by:
    
    cancelExportTask in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    createExportTask in interface AWSLogs
    
    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
```
public 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).
    Specified by:
    
    createLogGroup in interface AWSLogs
    
    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
```
public 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.
    Specified by:
    
    createLogStream in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    deleteDestination in interface AWSLogs
    
    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
```
public DeleteLogGroupResult deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest)
```
    Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
    
    Specified by:
    
    deleteLogGroup in interface AWSLogs
    
    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
```
public DeleteLogStreamResult deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest)
```
    Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
    
    Specified by:
    
    deleteLogStream in interface AWSLogs
    
    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
```
public DeleteMetricFilterResult deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest)
```
    Deletes the specified metric filter.
    
    Specified by:
    
    deleteMetricFilter in interface AWSLogs
    
    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
```
public DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest)
```
    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
    
    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
```
public DeleteSubscriptionFilterResult deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest)
```
    Deletes the specified subscription filter.
    
    Specified by:
    
    deleteSubscriptionFilter in interface AWSLogs
    
    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
```
public DescribeDestinationsResult describeDestinations(DescribeDestinationsRequest describeDestinationsRequest)
```
    Lists all your destinations. The results are ASCII-sorted by destination name.
    
    Specified by:
    
    describeDestinations in interface AWSLogs
    
    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
```
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 describeExportTasksRequest)
```
    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
    
    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
```
public 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.
    
    Specified by:
    
    describeLogGroups in interface AWSLogs
    
    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
```
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 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.
    
    Specified by:
    
    describeLogStreams in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    describeMetricFilters in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    describeSubscriptionFilters in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    filterLogEvents in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    getLogEvents in interface AWSLogs
    
    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
```
public ListTagsLogGroupResult listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest)
```
    Lists the tags for the specified log group.
    
    To add tags, use TagLogGroup. To remove tags, use UntagLogGroup.
    
    Specified by:
    
    listTagsLogGroup in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    putDestination in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    putDestinationPolicy in interface AWSLogs
    
    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
```
public 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.
    Specified by:
    
    putLogEvents in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    putMetricFilter in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    putRetentionPolicy in interface AWSLogs
    
    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
```
public 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.
    Specified by:
    
    putSubscriptionFilter in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    tagLogGroup in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    testMetricFilter in interface AWSLogs
    
    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
```
public 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.
    
    Specified by:
    
    untagLogGroup in interface AWSLogs
    
    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
  - getCachedResponseMetadata
```
public 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 the 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 AWSLogsClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSLogsClient

AWSLogsClient

AWSLogsClient

AWSLogsClient

AWSLogsClient

AWSLogsClient

AWSLogsClient

Method Detail

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

getCachedResponseMetadata