AbstractAWSLogs (AWS SDK for Java

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

All Implemented Interfaces:

AWSLogs

Direct Known Subclasses:

AbstractAWSLogsAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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
`AssociateKmsKeyResult`	`associateKmsKey(AssociateKmsKeyRequest request)` Associates the specified Key Management Service customer master key (CMK) with the specified log group.
`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.
`DeleteQueryDefinitionResult`	`deleteQueryDefinition(DeleteQueryDefinitionRequest request)` Deletes a saved CloudWatch Logs Insights query definition.
`DeleteResourcePolicyResult`	`deleteResourcePolicy(DeleteResourcePolicyRequest request)` Deletes a resource policy from this account.
`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.
`DescribeQueriesResult`	`describeQueries(DescribeQueriesRequest request)` Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account.
`DescribeQueryDefinitionsResult`	`describeQueryDefinitions(DescribeQueryDefinitionsRequest request)` This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
`DescribeResourcePoliciesResult`	`describeResourcePolicies(DescribeResourcePoliciesRequest request)` Lists the resource policies in this account.
`DescribeSubscriptionFiltersResult`	`describeSubscriptionFilters(DescribeSubscriptionFiltersRequest request)` Lists the subscription filters for the specified log group.
`DisassociateKmsKeyResult`	`disassociateKmsKey(DisassociateKmsKeyRequest request)` Disassociates the associated Key Management Service customer master key (CMK) from 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.
`GetLogGroupFieldsResult`	`getLogGroupFields(GetLogGroupFieldsRequest request)` Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field.
`GetLogRecordResult`	`getLogRecord(GetLogRecordRequest request)` Retrieves all of the fields and values of a single log event.
`GetQueryResultsResult`	`getQueryResults(GetQueryResultsRequest request)` Returns the results from the specified query.
`ListTagsLogGroupResult`	`listTagsLogGroup(ListTagsLogGroupRequest request)` Lists the tags for the specified log group.
`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.
`PutQueryDefinitionResult`	`putQueryDefinition(PutQueryDefinitionRequest request)` Creates or updates a query definition for CloudWatch Logs Insights.
`PutResourcePolicyResult`	`putResourcePolicy(PutResourcePolicyRequest request)` Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53.
`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.
`StartQueryResult`	`startQuery(StartQueryRequest request)` Schedules a query of a log group using CloudWatch Logs Insights.
`StopQueryResult`	`stopQuery(StopQueryRequest request)` Stops a CloudWatch Logs Insights query that is in progress.
`TagLogGroupResult`	`tagLogGroup(TagLogGroupRequest request)` Adds or updates the specified tags for the specified log group.
`TestMetricFilterResult`	`testMetricFilter(TestMetricFilterRequest request)` Tests the filter pattern of a metric filter against a sample of log event messages.
`UntagLogGroupResult`	`untagLogGroup(UntagLogGroupRequest request)` 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

- 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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    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)
  - associateKmsKey
```
public AssociateKmsKeyResult associateKmsKey(AssociateKmsKeyRequest request)
```
    Description copied from interface: AWSLogs
    
    Associates the specified Key Management Service customer master key (CMK) with the specified log group.
    
    Associating an KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
    
    CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.
    
    It can take up to 5 minutes for this operation to take effect.
    
    If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you receive an InvalidParameterException error.
    
    Specified by:
    
    associateKmsKey in interface AWSLogs
    
    Returns:
    
    Result of the AssociateKmsKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    See Also:
    
    AWS API Documentation
  - 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. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.
    
    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 to be used as the Amazon S3 key prefix for all exported objects.
    
    Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets encrypted with SSE-KMS is not supported.
    
    Specified by:
    
    createExportTask in interface AWSLogs
    
    Returns:
    
    Result of the CreateExportTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLogGroup
```
public CreateLogGroupResult createLogGroup(CreateLogGroupRequest request)
```
    Description copied from interface: AWSLogs
    Creates a log group with the specified name. You can create up to 20,000 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 Amazon Web Services 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), '.' (period), and '#' (number sign)
    When you create a log group, by default the log events in the log group never expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
    
    If you associate a Key Management Service customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
    
    If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you receive an InvalidParameterException error.
    
    CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys.
    Specified by:
    
    createLogGroup in interface AWSLogs
    
    Returns:
    
    Result of the CreateLogGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLogStream
```
public CreateLogStreamResult createLogStream(CreateLogStreamRequest request)
```
    Description copied from interface: AWSLogs
    Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
    
    There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    See Also:
    
    AWS API Documentation
  - deleteQueryDefinition
```
public DeleteQueryDefinitionResult deleteQueryDefinition(DeleteQueryDefinitionRequest request)
```
    Description copied from interface: AWSLogs
    
    Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
    
    Each DeleteQueryDefinition operation can delete one query definition.
    
    You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.
    
    Specified by:
    
    deleteQueryDefinition in interface AWSLogs
    
    Returns:
    
    Result of the DeleteQueryDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteResourcePolicy
```
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
```
    Description copied from interface: AWSLogs
    
    Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.
    
    Specified by:
    
    deleteResourcePolicy in interface AWSLogs
    
    Returns:
    
    Result of the DeleteResourcePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    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 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.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
    
    Specified by:
    
    describeLogGroups in interface AWSLogs
    
    Returns:
    
    Result of the DescribeLogGroups operation returned by the service.
    
    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 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.
    
    See Also:
    
    AWS API Documentation
  - describeMetricFilters
```
public DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists the specified metric filters. You can list all of 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.
    
    See Also:
    
    AWS API Documentation
  - describeQueries
```
public DescribeQueriesResult describeQueries(DescribeQueriesRequest request)
```
    Description copied from interface: AWSLogs
    
    Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
    
    Specified by:
    
    describeQueries in interface AWSLogs
    
    Returns:
    
    Result of the DescribeQueries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeQueryDefinitions
```
public DescribeQueryDefinitionsResult describeQueryDefinitions(DescribeQueryDefinitionsRequest request)
```
    Description copied from interface: AWSLogs
    
    This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
    
    You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string.
    
    Specified by:
    
    describeQueryDefinitions in interface AWSLogs
    
    Returns:
    
    Result of the DescribeQueryDefinitions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeResourcePolicies
```
public DescribeResourcePoliciesResult describeResourcePolicies(DescribeResourcePoliciesRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists the resource policies in this account.
    
    Specified by:
    
    describeResourcePolicies in interface AWSLogs
    
    Returns:
    
    Result of the DescribeResourcePolicies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    See Also:
    
    AWS API Documentation
  - disassociateKmsKey
```
public DisassociateKmsKeyResult disassociateKmsKey(DisassociateKmsKeyRequest request)
```
    Description copied from interface: AWSLogs
    
    Disassociates the associated Key Management Service customer master key (CMK) from the specified log group.
    
    After the KMS CMK is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.
    
    Note that it can take up to 5 minutes for this operation to take effect.
    
    Specified by:
    
    disassociateKmsKey in interface AWSLogs
    
    Returns:
    
    Result of the DisassociateKmsKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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 1 MB (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. This operation can return empty results while there are more log events available through the token.
    
    The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.
    
    Specified by:
    
    filterLogEvents in interface AWSLogs
    
    Returns:
    
    Result of the FilterLogEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getLogEvents
```
public GetLogEventsResult getLogEvents(GetLogEventsRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists log events from the specified log stream. You can list all of 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). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.
    
    Specified by:
    
    getLogEvents in interface AWSLogs
    
    Returns:
    
    Result of the GetLogEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getLogGroupFields
```
public GetLogGroupFieldsResult getLogGroupFields(GetLogGroupFieldsRequest request)
```
    Description copied from interface: AWSLogs
    
    Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify.
    
    In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.
    
    The response results are sorted by the frequency percentage, starting with the highest percentage.
    
    Specified by:
    
    getLogGroupFields in interface AWSLogs
    
    Returns:
    
    Result of the GetLogGroupFields operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getLogRecord
```
public GetLogRecordResult getLogRecord(GetLogRecordRequest request)
```
    Description copied from interface: AWSLogs
    
    Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.
    
    The full unparsed log event is returned within @message.
    
    Specified by:
    
    getLogRecord in interface AWSLogs
    
    Returns:
    
    Result of the GetLogRecord operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getQueryResults
```
public GetQueryResultsResult getQueryResults(GetQueryResultsRequest request)
```
    Description copied from interface: AWSLogs
    
    Returns the results from the specified query.
    
    Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.
    
    GetQueryResults does not start a query execution. To run a query, use StartQuery.
    
    If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.
    
    Specified by:
    
    getQueryResults in interface AWSLogs
    
    Returns:
    
    Result of the GetQueryResults operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsLogGroup
```
public ListTagsLogGroupResult listTagsLogGroup(ListTagsLogGroupRequest request)
```
    Description copied from interface: AWSLogs
    
    Lists the tags for the specified log group.
    
    Specified by:
    
    listTagsLogGroup in interface AWSLogs
    
    Returns:
    
    Result of the ListTagsLogGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putDestination
```
public PutDestinationResult putDestination(PutDestinationRequest request)
```
    Description copied from interface: AWSLogs
    
    Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
    
    A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.
    
    Through an access policy, a destination controls what is written to it. 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.
    
    To perform a PutDestination operation, you must also have the iam:PassRole permission.
    
    Specified by:
    
    putDestination in interface AWSLogs
    
    Returns:
    
    Result of the PutDestination operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be listed separately in the policy. The policy does not support specifying * as the Principal or the use of the aws:PrincipalOrgId global key.
    
    Specified by:
    
    putDestinationPolicy in interface AWSLogs
    
    Returns:
    
    Result of the PutDestinationPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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 in the expectedSequenceToken field from InvalidSequenceTokenException. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected.
    
    The batch of events must satisfy the following constraints:
    - The maximum batch size is 1,048,576 bytes. 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 older than the retention period of the log group.
    - The log events in the batch must be in chronological order by their timestamp. The timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
    - A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
    - The maximum number of log events in a batch is 10,000.
    - There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.
    If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid Amazon Web Services access key ID or secret key.
    Specified by:
    
    putLogEvents in interface AWSLogs
    
    Returns:
    
    Result of the PutLogEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
    
    Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
    
    To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.
    
    You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
    
    Specified by:
    
    putMetricFilter in interface AWSLogs
    
    Returns:
    
    Result of the PutMetricFilter operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putQueryDefinition
```
public PutQueryDefinitionResult putQueryDefinition(PutQueryDefinitionRequest request)
```
    Description copied from interface: AWSLogs
    
    Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
    
    To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, if you update a current query definition that includes log groups, and you don't specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups.
    
    You must have the logs:PutQueryDefinition permission to be able to perform this operation.
    
    Specified by:
    
    putQueryDefinition in interface AWSLogs
    
    Returns:
    
    Result of the PutQueryDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putResourcePolicy
```
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
```
    Description copied from interface: AWSLogs
    
    Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.
    
    Specified by:
    
    putResourcePolicy in interface AWSLogs
    
    Returns:
    
    Result of the PutResourcePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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 for which 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.
    
    See Also:
    
    AWS API Documentation
  - 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. When log events are sent to the receiving service, they are Base64 encoded and compressed with the gzip format.
    
    The following destinations are supported for subscription filters:
    - 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 delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
    - An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
    Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName.
    
    To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole permission.
    Specified by:
    
    putSubscriptionFilter in interface AWSLogs
    
    Returns:
    
    Result of the PutSubscriptionFilter operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startQuery
```
public StartQueryResult startQuery(StartQueryRequest request)
```
    Description copied from interface: AWSLogs
    
    Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.
    
    For more information, see CloudWatch Logs Insights Query Syntax.
    
    Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
    
    Specified by:
    
    startQuery in interface AWSLogs
    
    Returns:
    
    Result of the StartQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopQuery
```
public StopQueryResult stopQuery(StopQueryRequest request)
```
    Description copied from interface: AWSLogs
    
    Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.
    
    Specified by:
    
    stopQuery in interface AWSLogs
    
    Returns:
    
    Result of the StopQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagLogGroup
```
public TagLogGroupResult tagLogGroup(TagLogGroupRequest request)
```
    Description copied from interface: AWSLogs
    
    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.
    
    CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
    
    Specified by:
    
    tagLogGroup in interface AWSLogs
    
    Returns:
    
    Result of the TagLogGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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.
    
    See Also:
    
    AWS API Documentation
  - untagLogGroup
```
public UntagLogGroupResult untagLogGroup(UntagLogGroupRequest request)
```
    Description copied from interface: AWSLogs
    
    Removes the specified tags from the specified log group.
    
    To list the tags for a log group, use ListTagsLogGroup. To add tags, use TagLogGroup.
    
    CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys.
    
    Specified by:
    
    untagLogGroup in interface AWSLogs
    
    Returns:
    
    Result of the UntagLogGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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

associateKmsKey

cancelExportTask

createExportTask

createLogGroup

createLogStream

deleteDestination

deleteLogGroup

deleteLogStream

deleteMetricFilter

deleteQueryDefinition

deleteResourcePolicy

deleteRetentionPolicy

deleteSubscriptionFilter

describeDestinations

describeDestinations

describeExportTasks

describeLogGroups

describeLogGroups

describeLogStreams

describeMetricFilters

describeQueries

describeQueryDefinitions

describeResourcePolicies

describeSubscriptionFilters

disassociateKmsKey

filterLogEvents

getLogEvents

getLogGroupFields

getLogRecord

getQueryResults

listTagsLogGroup

putDestination

putDestinationPolicy

putLogEvents

putMetricFilter

putQueryDefinition

putResourcePolicy

putRetentionPolicy

putSubscriptionFilter

startQuery

stopQuery

tagLogGroup

testMetricFilter

untagLogGroup

shutdown

getCachedResponseMetadata