* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.logs.AbstractAWSLogs} instead. *
**
* You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and * other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. * Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or * CloudWatch Logs SDK. *
** You can use CloudWatch Logs to: *
** Monitor logs from 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. * Then, it can send you a notification whenever the rate of errors exceeds a threshold that 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"). You can also 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 CloudWatch metric that you specify. *
** Monitor CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular * API activity as captured by CloudTrail. You can 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 earlier than this setting are automatically deleted. The CloudWatch * Logs agent helps 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. *
** 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 {@link 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. * * @param 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. * @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for * example: * {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));} */ @Deprecated void setEndpoint(String endpoint); /** * An alternative to {@link 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 * {@link 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. * * @param region * The region this client will communicate with. See {@link 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 Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) * @see Region#isServiceSupported(String) * @deprecated use {@link AwsClientBuilder#setRegion(String)} */ @Deprecated void setRegion(Region region); /** *
* Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs * query insights results in the account. *
*
* When you use AssociateKmsKey, you specify either the logGroupName parameter or the
* resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
*
* Specify the logGroupName parameter to cause all log events stored in the log group to be encrypted
* with that key. Only the log events ingested after the key is associated are encrypted with that key.
*
* Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. * After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the * KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch * Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. *
*
* Associating a key with a log group does not cause the results of queries of that log group to be encrypted with
* that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey operation
* with the resourceIdentifier parameter that specifies a query-result resource.
*
* Specify the resourceIdentifier parameter with a query-result resource, to use that key
* to encrypt the stored results of all future StartQuery
* operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.
*
* Even if you have not associated a key with your query results, the query results are encrypted when stored, using * the default CloudWatch Logs method. *
** If you run a query from a monitoring account that queries logs in a source account, the query results key from * the monitoring account, if any, is used. *
** If you delete the key that is used to encrypt log events or log group query results, then all the associated * stored log events or query results that were encrypted with that key will be unencryptable and unusable. *
** CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log * group or query results. 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 KMS key with a log group but the KMS key does not exist or the KMS key is disabled,
* you receive an InvalidParameterException error.
*
* Cancels the specified export task. *
*
* The task must be in the PENDING or RUNNING state.
*
* Creates an export task so that you can 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.
*
* Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets * that have S3 Object Lock enabled with a retention period is also supported. *
** Exporting to S3 buckets that are encrypted with AES-256 is supported. *
*
* 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 log data * for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects. *
** Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log * field data by using Linux utilities. *
** 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 do not expire. To set a retention policy * so that events expire and are deleted after a specified time, use PutRetentionPolicy. *
** If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is * stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch * Logs to decrypt this data whenever it is requested. *
*
* If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is
* disabled, you receive an InvalidParameterException error.
*
* CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For * more information, see Using Symmetric and * Asymmetric Keys. *
** 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. *
** Don't use ':' (colon) or '*' (asterisk) characters. *
** Deletes a CloudWatch Logs account policy. *
*
* To use this operation, you must be signed on with the logs:DeleteDataProtectionPolicy and
* logs:DeleteAccountPolicy permissions.
*
* Deletes the data protection policy from the specified log group. *
** For more information about data protection policies, see PutDataProtectionPolicy. *
* * @param deleteDataProtectionPolicyRequest * @return Result of the DeleteDataProtectionPolicy operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws OperationAbortedException * Multiple concurrent requests to update the same resource were in conflict. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DeleteDataProtectionPolicy * @see AWS API Documentation */ DeleteDataProtectionPolicyResult deleteDataProtectionPolicy(DeleteDataProtectionPolicyRequest deleteDataProtectionPolicyRequest); /** ** 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. *
* * @param deleteDestinationRequest * @return Result of the DeleteDestination operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws OperationAbortedException * Multiple concurrent requests to update the same resource were in conflict. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DeleteDestination * @see AWS API * Documentation */ DeleteDestinationResult deleteDestination(DeleteDestinationRequest deleteDestinationRequest); /** ** Deletes the specified log group and permanently deletes all the archived log events associated with the log * group. *
* * @param deleteLogGroupRequest * @return Result of the DeleteLogGroup operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws OperationAbortedException * Multiple concurrent requests to update the same resource were in conflict. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DeleteLogGroup * @see AWS API * Documentation */ DeleteLogGroupResult deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest); /** ** Deletes the specified log stream and permanently deletes all the archived log events associated with the log * stream. *
* * @param deleteLogStreamRequest * @return Result of the DeleteLogStream operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws OperationAbortedException * Multiple concurrent requests to update the same resource were in conflict. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DeleteLogStream * @see AWS API * Documentation */ DeleteLogStreamResult deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest); /** ** Deletes the specified metric filter. *
* * @param deleteMetricFilterRequest * @return Result of the DeleteMetricFilter operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws OperationAbortedException * Multiple concurrent requests to update the same resource were in conflict. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DeleteMetricFilter * @see AWS API * Documentation */ DeleteMetricFilterResult deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest); /** ** 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.
*
* Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log * events to this account. *
* * @param deleteResourcePolicyRequest * @return Result of the DeleteResourcePolicy operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DeleteResourcePolicy * @see AWS API * Documentation */ DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest); /** ** Deletes the specified retention policy. *
** Log events do not expire if they belong to log groups without a retention policy. *
* * @param deleteRetentionPolicyRequest * @return Result of the DeleteRetentionPolicy operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws OperationAbortedException * Multiple concurrent requests to update the same resource were in conflict. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DeleteRetentionPolicy * @see AWS API * Documentation */ DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest deleteRetentionPolicyRequest); /** ** Deletes the specified subscription filter. *
* * @param deleteSubscriptionFilterRequest * @return Result of the DeleteSubscriptionFilter operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws OperationAbortedException * Multiple concurrent requests to update the same resource were in conflict. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DeleteSubscriptionFilter * @see AWS * API Documentation */ DeleteSubscriptionFilterResult deleteSubscriptionFilter(DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest); /** ** Returns a list of all CloudWatch Logs account policies in the account. *
* * @param describeAccountPoliciesRequest * @return Result of the DescribeAccountPolicies operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws OperationAbortedException * Multiple concurrent requests to update the same resource were in conflict. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DescribeAccountPolicies * @see AWS * API Documentation */ DescribeAccountPoliciesResult describeAccountPolicies(DescribeAccountPoliciesRequest describeAccountPoliciesRequest); /** ** Lists all your destinations. The results are ASCII-sorted by destination name. *
* * @param describeDestinationsRequest * @return Result of the DescribeDestinations operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DescribeDestinations * @see AWS API * Documentation */ DescribeDestinationsResult describeDestinations(DescribeDestinationsRequest describeDestinationsRequest); /** * Simplified method form for invoking the DescribeDestinations operation. * * @see #describeDestinations(DescribeDestinationsRequest) */ DescribeDestinationsResult describeDestinations(); /** ** Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or * task status. *
* * @param describeExportTasksRequest * @return Result of the DescribeExportTasks operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DescribeExportTasks * @see AWS API * Documentation */ DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest describeExportTasksRequest); /** ** 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.
*
* If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and * view data from the linked source accounts. For more information, see CloudWatch cross-account observability. *
* * @param describeLogGroupsRequest * @return Result of the DescribeLogGroups operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DescribeLogGroups * @see AWS API * Documentation */ DescribeLogGroupsResult describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest); /** * Simplified method form for invoking the DescribeLogGroups operation. * * @see #describeLogGroups(DescribeLogGroupsRequest) */ DescribeLogGroupsResult describeLogGroups(); /** ** 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. *
*
* You can specify the log group to search by using either logGroupIdentifier or
* logGroupName. You must include one of these two parameters, but you can't include both.
*
* This operation has a limit of five transactions per second, after which transactions are throttled. *
** If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and * view data from the linked source accounts. For more information, see CloudWatch cross-account observability. *
* * @param describeLogStreamsRequest * @return Result of the DescribeLogStreams operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DescribeLogStreams * @see AWS API * Documentation */ DescribeLogStreamsResult describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest); /** ** 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. *
* * @param describeMetricFiltersRequest * @return Result of the DescribeMetricFilters operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DescribeMetricFilters * @see AWS API * Documentation */ DescribeMetricFiltersResult describeMetricFilters(DescribeMetricFiltersRequest describeMetricFiltersRequest); /** ** Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run 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. *
* * @param describeQueriesRequest * @return Result of the DescribeQueries operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DescribeQueries * @see AWS API * Documentation */ DescribeQueriesResult describeQueries(DescribeQueriesRequest describeQueriesRequest); /** ** 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.
*
* Lists the resource policies in this account. *
* * @param describeResourcePoliciesRequest * @return Result of the DescribeResourcePolicies operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DescribeResourcePolicies * @see AWS * API Documentation */ DescribeResourcePoliciesResult describeResourcePolicies(DescribeResourcePoliciesRequest describeResourcePoliciesRequest); /** ** 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. *
* * @param describeSubscriptionFiltersRequest * @return Result of the DescribeSubscriptionFilters operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DescribeSubscriptionFilters * @see AWS API Documentation */ DescribeSubscriptionFiltersResult describeSubscriptionFilters(DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest); /** ** Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query * results in the account. *
*
* When you use DisassociateKmsKey, you specify either the logGroupName parameter or the
* resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
*
* Specify the logGroupName parameter to stop using the KMS key to encrypt future log events ingested
* and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log
* events that were ingested while the key was associated with the log group are still encrypted with that key.
* Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.
*
* Specify the resourceIdentifier parameter with the query-result resource to stop using
* the KMS key to encrypt the results of all future StartQuery
* operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results
* from queries that ran while the key was associated with the account are still encrypted with that key. Therefore,
* CloudWatch Logs will need permissions for the key whenever that data is accessed.
*
* It can take up to 5 minutes for this operation to take effect. *
* * @param disassociateKmsKeyRequest * @return Result of the DisassociateKmsKey operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws OperationAbortedException * Multiple concurrent requests to update the same resource were in conflict. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.DisassociateKmsKey * @see AWS API * Documentation */ DisassociateKmsKeyResult disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest); /** ** 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. *
*
* You must have the logs:FilterLogEvents permission to perform this operation.
*
* You can specify the log group to search by using either logGroupIdentifier or
* logGroupName. You must include one of these two parameters, but you can't include both.
*
* 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 specified time range. If the results include a token, that means there are more log * events available. 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.
*
* If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and * view data from the linked source accounts. For more information, see CloudWatch cross-account observability. *
* * @param filterLogEventsRequest * @return Result of the FilterLogEvents operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.FilterLogEvents * @see AWS API * Documentation */ FilterLogEventsResult filterLogEvents(FilterLogEventsRequest filterLogEventsRequest); /** ** Returns information about a log group data protection policy. *
* * @param getDataProtectionPolicyRequest * @return Result of the GetDataProtectionPolicy operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws OperationAbortedException * Multiple concurrent requests to update the same resource were in conflict. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.GetDataProtectionPolicy * @see AWS * API Documentation */ GetDataProtectionPolicyResult getDataProtectionPolicy(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest); /** ** 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. *
** If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and * view data from the linked source accounts. For more information, see CloudWatch cross-account observability. *
*
* You can specify the log group to search by using either logGroupIdentifier or
* logGroupName. You must include one of these two parameters, but you can't include both.
*
* Returns a list of the fields that are included in log events in the specified log group. Includes the percentage * of log events that contain each field. The search is limited to a time period that you specify. *
*
* You can specify the log group to search by using either logGroupIdentifier or
* logGroupName. You must specify one of these parameters, but you can't specify both.
*
* 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. *
** If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and * view data from the linked source accounts. For more information, see CloudWatch cross-account observability. *
* * @param getLogGroupFieldsRequest * @return Result of the GetLogGroupFields operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws LimitExceededException * You have reached the maximum number of resources that can be created. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.GetLogGroupFields * @see AWS API * Documentation */ GetLogGroupFieldsResult getLogGroupFields(GetLogGroupFieldsRequest getLogGroupFieldsRequest); /** *
* 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.
*
* 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 running a query. 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.
*
* If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to * start queries in linked source accounts. For more information, see CloudWatch cross-account observability. *
* * @param getQueryResultsRequest * @return Result of the GetQueryResults operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.GetQueryResults * @see AWS API * Documentation */ GetQueryResultsResult getQueryResults(GetQueryResultsRequest getQueryResultsRequest); /** ** Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support * tagging. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.ListTagsForResource * @see AWS API * Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** ** The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead. *
** Lists the tags for the specified log group. *
* * @param listTagsLogGroupRequest * @return Result of the ListTagsLogGroup operation returned by the service. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.ListTagsLogGroup * @see AWS API * Documentation */ @Deprecated ListTagsLogGroupResult listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest); /** ** Creates an account-level data protection policy that applies to all log groups in the account. A data protection * policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive * log data. Each account can have only one account-level policy. *
** Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection * policy, log events ingested into the log groups before that time are not masked. *
*
* If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to
* both existing log groups and all log groups that are created later in this account. The account policy is applied
* to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing
* log groups begins to be masked.
*
* By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
* A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the
* unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs
* console by running a CloudWatch Logs Insights query with the unmask query command.
*
* For more information, including a list of types of data that can be audited and masked, see Protect sensitive * log data with masking. *
*
* To use the PutAccountPolicy operation, you must be signed on with the
* logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions.
*
* The PutAccountPolicy operation applies to all log groups in the account. You can also use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log
* group has its own data protection policy and the account also has an account-level data protection policy, then
* the two policies are cumulative. Any sensitive term specified in either policy is masked.
*
* Creates a data protection policy for the specified log group. A data protection policy can help safeguard * sensitive data that's ingested by the log group by auditing and masking the sensitive log data. *
** Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection * policy, log events ingested into the log group before that time are not masked. *
*
* By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
* A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the
* unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs
* console by running a CloudWatch Logs Insights query with the unmask query command.
*
* For more information, including a list of types of data that can be audited and masked, see Protect sensitive * log data with masking. *
*
* The PutDataProtectionPolicy operation applies to only the specified log group. You can also use
* PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the
* account, including both existing log groups and log groups that are created level. If a log group has its own
* data protection policy and the account also has an account-level data protection policy, then the two policies
* are cumulative. Any sensitive term specified in either policy is masked.
*
* 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). With a destination, you can * 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.
*
* 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. *
* * @param putDestinationPolicyRequest * @return Result of the PutDestinationPolicy operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws OperationAbortedException * Multiple concurrent requests to update the same resource were in conflict. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.PutDestinationPolicy * @see AWS API * Documentation */ PutDestinationPolicyResult putDestinationPolicy(PutDestinationPolicyRequest putDestinationPolicyRequest); /** ** Uploads a batch of log events to the specified log stream. *
*
* The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are
* always accepted and never return InvalidSequenceTokenException or
* DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel
* PutLogEvents actions on the same log stream.
*
* 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 more than 14 days in the past. Also, none of the log events can be * from earlier 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 that 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. *
** Each log event can be no larger than 256 KB. *
** The maximum number of log events in a batch is 10,000. *
*
* The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions
* are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling
* quota by using the Service Quotas service.
*
* If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid
* Amazon Web Services access key ID or secret key.
*
expectedSequenceToken field in the InvalidSequenceTokenException message.
*
* PutLogEvents actions are now always accepted and never return
* InvalidSequenceTokenException regardless of receiving an invalid sequence token.
*
* PutLogEvents actions are now always accepted and never return
* DataAlreadyAcceptedException regardless of whether a given batch of log events has already
* been accepted.
*
* Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can * 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.
*
* CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for your specified * dimensions within a certain amount of time. This helps to prevent accidental high charges. *
** 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. *
** 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,
* imagine updating a current query definition that includes log groups. If 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.
*
* 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. *
* * @param putResourcePolicyRequest * @return Result of the PutResourcePolicy operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws LimitExceededException * You have reached the maximum number of resources that can be created. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.PutResourcePolicy * @see AWS API * Documentation */ PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest); /** ** Sets the retention of the specified log group. With a retention policy, you can configure the number of days for * which to retain log events in the specified log group. *
** CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes * up to 72 hours after that before log events are deleted, but in rare situations might take longer. *
** To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events * that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be * deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log * group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait * to change the retention setting until you confirm that the earlier log events are deleted. *
** Creates or updates a subscription filter and associates it with the specified log group. With subscription * filters, you can 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 data stream belonging to the same account as the subscription filter, for same-account * delivery. *
** A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis * Data Streams and Kinesis Data Firehose as logical destinations. *
** An Amazon Kinesis Data 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 for any destination except a Lambda function, you must
* also have the iam:PassRole permission.
*
* 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. *
*
* After you run a query using StartQuery, the query results are stored by CloudWatch Logs. You can use
*
* GetQueryResults to retrieve the results of a query, using the queryId that
* StartQuery returns.
*
* If you have associated a KMS key with the query results in this account, then StartQuery * uses that key to encrypt the results when it stores them. If no key is associated with query results, the query * results are encrypted with the default CloudWatch Logs encryption method. *
** Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being * searched or partition your query into a number of queries. *
*
* If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to
* start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query
* definition must be defined in the monitoring account.
*
* You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to * dashboards. *
* * @param startQueryRequest * @return Result of the StartQuery operation returned by the service. * @throws MalformedQueryException * The query string is not valid. Details about this error are displayed in aQueryCompileError
* object. For more information, see QueryCompileError.
* * For more information about valid query syntax, see CloudWatch Logs * Insights Query Syntax. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws LimitExceededException * You have reached the maximum number of resources that can be created. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.StartQuery * @see AWS API * Documentation */ StartQueryResult startQuery(StartQueryRequest startQueryRequest); /** *
* 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. *
* * @param stopQueryRequest * @return Result of the StopQuery operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.StopQuery * @see AWS API * Documentation */ StopQueryResult stopQuery(StopQueryRequest stopQueryRequest); /** ** The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource * instead. *
** Adds or updates the specified tags for the specified log group. *
** To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource. *
** 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.
*
* Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only * CloudWatch Logs resources that can be tagged are log groups and destinations. *
** Tags can help you organize and categorize your resources. You can also use them to scope user permissions by * granting a user permission to access or change only resources with certain tag values. *
** Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of * characters. *
*
* You can use the TagResource action with a resource that already has tags. If you specify a new tag
* key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key
* that is already associated with the alarm, the new tag value that you specify replaces the previous value for
* that tag.
*
* You can associate as many as 50 tags with a CloudWatch Logs resource. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @throws TooManyTagsException * A resource can have no more than 50 tags. * @sample AWSLogs.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** ** 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. *
* * @param testMetricFilterRequest * @return Result of the TestMetricFilter operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.TestMetricFilter * @see AWS API * Documentation */ TestMetricFilterResult testMetricFilter(TestMetricFilterRequest testMetricFilterRequest); /** ** The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead. *
** Removes the specified tags from the specified log group. *
** To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource. *
*
* 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.
*
* Removes one or more tags from the specified resource. *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws InvalidParameterException * A parameter is specified incorrectly. * @throws ResourceNotFoundException * The specified resource does not exist. * @throws ServiceUnavailableException * The service cannot complete the request. * @sample AWSLogs.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** * 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. */ void shutdown(); /** * 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }