Package-level declarations

Types

Link copied to clipboard

You don't have sufficient permissions to perform this action.

Link copied to clipboard

A structure that contains information about one CloudWatch Logs account policy.

Link copied to clipboard

This object defines one key that will be added with the addKeys processor.

Link copied to clipboard
class AddKeys

This processor adds new key-value pairs to the log event.

Link copied to clipboard
class Anomaly

This structure represents one anomaly that has been found by a logs anomaly detector.

Link copied to clipboard

Contains information about one anomaly detector in the account.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Base class for all service related exceptions thrown by the CloudWatchLogs client

Link copied to clipboard

A structure containing information about the deafult settings and available settings that you can use to configure a delivery or a delivery destination.

This structure contains the default values that are used for each configuration parameter when you use CreateDelivery to create a deliver under the current service type, resource type, and log type.

Link copied to clipboard

This operation attempted to create a resource that already exists.

Link copied to clipboard
class CopyValue

This processor copies values within a log event. You can also use this processor to add metadata to log events by copying the values of the following metadata keys into the log events: @logGroupName, @logGroupStream, @accountId, @regionName.

Link copied to clipboard

This object defines one value to be copied with the copyValue processor.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Csv

The CSV processor parses comma-separated values (CSV) from the log events into columns.

Link copied to clipboard

The event was already logged.

Link copied to clipboard
Link copied to clipboard

This processor converts a datetime string into a format that you specify.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This processor deletes entries from a log event. These entries are key-value pairs.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Delivery

This structure contains information about one delivery in your account.

Link copied to clipboard

This structure contains information about one delivery destination in your account. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, Firehose, and X-Ray are supported as delivery destinations.

Link copied to clipboard

A structure that contains information about one logs delivery destination.

Link copied to clipboard
Link copied to clipboard

This structure contains information about one delivery source in your account. A delivery source is an Amazon Web Services resource that sends logs to an Amazon Web Services destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents a cross-account destination that receives subscription log events.

Link copied to clipboard
Link copied to clipboard
sealed class Distribution

The method used to distribute log data to the destination, which can be either random or grouped by log stream.

Link copied to clipboard
class Entity

The entity associated with the log events in a PutLogEvents call.

Link copied to clipboard
Link copied to clipboard
sealed class EvaluationFrequency
Link copied to clipboard
sealed class EventSource
Link copied to clipboard

Represents an export task.

Link copied to clipboard

Represents the status of an export task.

Link copied to clipboard

Represents the status of an export task.

Link copied to clipboard
Link copied to clipboard

This structure describes one log event field that is used as an index in at least one index policy in this account.

Link copied to clipboard

A structure containing the extracted fields from a log event. These fields are extracted based on the log format and can be used for structured querying and analysis.

Link copied to clipboard

Represents a matched event.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class FlattenedElement
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The parameters for the GetLogObject operation.

Link copied to clipboard

The response from the GetLogObject operation.

Link copied to clipboard

A stream of structured log data returned by the GetLogObject operation. This stream contains log events with their associated metadata and extracted fields.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Grok

This processor uses pattern matching to parse and structure unstructured data. This processor can also extract fields from log messages.

Link copied to clipboard

This structure contains information about one field index policy in this account.

Link copied to clipboard
sealed class IndexSource
Link copied to clipboard
sealed class InheritedProperty
Link copied to clipboard

Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.

Link copied to clipboard
sealed class IntegrationDetails

This structure contains information about the integration configuration. For an integration with OpenSearch Service, this includes information about OpenSearch Service resources such as the collection, the workspace, and policies.

Link copied to clipboard
sealed class IntegrationStatus
Link copied to clipboard

This structure contains information about one CloudWatch Logs integration. This structure is returned by a ListIntegrations operation.

Link copied to clipboard
sealed class IntegrationType
Link copied to clipboard

An internal error occurred during the streaming of log data. This exception is thrown when there's an issue with the internal streaming mechanism used by the GetLogObject operation.

Link copied to clipboard

The operation is not valid on the specified resource.

Link copied to clipboard

A parameter is specified incorrectly.

Link copied to clipboard

The sequence token is not valid. You can get the correct sequence token in the expectedSequenceToken field in the InvalidSequenceTokenException message.

Link copied to clipboard

You have reached the maximum number of resources that can be created.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class ListToMap

This processor takes a list of objects that contain key fields, and converts them into a map of target keys.

Link copied to clipboard

This object contains the information for one log event returned in a Live Tail stream.

Link copied to clipboard

This object contains the metadata for one LiveTailSessionUpdate structure. It indicates whether that update includes only a sample of 500 log events out of a larger number of ingested log events, or if it contains all of the matching log events ingested during that second of time.

Link copied to clipboard

This object contains information about this Live Tail session, including the log groups included and the log stream filters, if any.

Link copied to clipboard

This object contains the log events and metadata for a Live Tail session.

Link copied to clipboard
class LogEvent

This structure contains the information for one sample log event that is associated with an anomaly found by a log anomaly detector.

Link copied to clipboard
class LogGroup

Represents a log group.

Link copied to clipboard
sealed class LogGroupClass
Link copied to clipboard

The fields contained in log events found by a GetLogGroupFields operation, along with the percentage of queried log events in which each field appears.

Link copied to clipboard

This structure contains information about one log group in your account.

Link copied to clipboard
class LogStream

Represents a log stream, which is a sequence of log events from a single emitter of logs.

Link copied to clipboard

This processor converts a string to lowercase.

Link copied to clipboard

The query string is not valid. Details about this error are displayed in a QueryCompileError object. For more information, see QueryCompileError.

Link copied to clipboard

Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.

Link copied to clipboard

Represents a matched event.

Link copied to clipboard

Indicates how to transform ingested log events to metric data in a CloudWatch metric.

Link copied to clipboard

This object defines one key that will be moved with the moveKey processor.

Link copied to clipboard
class MoveKeys

This processor moves a key from one field to another. The original key is deleted.

Link copied to clipboard
sealed class OcsfVersion
Link copied to clipboard

This structure contains information about the OpenSearch Service application used for this integration. An OpenSearch Service application is the web application created by the integration with CloudWatch Logs. It hosts the vended logs dashboards.

Link copied to clipboard

This structure contains information about the OpenSearch Service collection used for this integration. An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics workload. For more information, see Creating and managing OpenSearch Service Serverless collections.

Link copied to clipboard

This structure contains information about the OpenSearch Service data access policy used for this integration. The access policy defines the access controls for the collection. This data access policy was automatically created as part of the integration setup. For more information about OpenSearch Service data access policies, see Data access control for Amazon OpenSearch Serverless in the OpenSearch Service Developer Guide.

Link copied to clipboard

This structure contains information about the OpenSearch Service data source used for this integration. This data source was created as part of the integration setup. An OpenSearch Service data source defines the source and destination for OpenSearch Service queries. It includes the role required to execute queries and write to collections.

Link copied to clipboard

This structure contains information about the OpenSearch Service encryption policy used for this integration. The encryption policy was created automatically when you created the integration. For more information, see Encryption policies in the OpenSearch Service Developer Guide.

Link copied to clipboard

This structure contains complete information about one CloudWatch Logs integration. This structure is returned by a GetIntegration operation.

Link copied to clipboard

This structure contains information about the OpenSearch Service data lifecycle policy used for this integration. The lifecycle policy determines the lifespan of the data in the collection. It was automatically created as part of the integration setup.

Link copied to clipboard

This structure contains information about the OpenSearch Service network policy used for this integration. The network policy assigns network access settings to collections. For more information, see Network policies in the OpenSearch Service Developer Guide.

Link copied to clipboard

This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.

Link copied to clipboard

This structure contains information about the status of an OpenSearch Service resource.

Link copied to clipboard
Link copied to clipboard

This structure contains information about the OpenSearch Service workspace used for this integration. An OpenSearch Service workspace is the collection of dashboards along with other OpenSearch Service tools. This workspace was created automatically as part of the integration setup. For more information, see Centralized OpenSearch user interface (Dashboards) with OpenSearch Service.

Link copied to clipboard

Multiple concurrent requests to update the same resource were in conflict.

Link copied to clipboard
sealed class OrderBy
Link copied to clipboard
sealed class OutputFormat
Link copied to clipboard

Represents a log event.

Link copied to clipboard

This processor parses CloudFront vended logs, extract fields, and convert them into JSON format. Encoded field values are decoded. Values that are integers and doubles are treated as such. For more information about this processor including examples, see parseCloudfront

Link copied to clipboard
class ParseJson

This processor parses log events that are in JSON format. It can extract JSON key-value pairs and place them under a destination that you specify.

Link copied to clipboard

This processor parses a specified field in the original log event into key-value pairs.

Link copied to clipboard

Use this processor to parse RDS for PostgreSQL vended logs, extract fields, and and convert them into a JSON format. This processor always processes the entire log event message. For more information about this processor including examples, see parsePostGres.

Link copied to clipboard

Use this processor to parse Route 53 vended logs, extract fields, and and convert them into a JSON format. This processor always processes the entire log event message. For more information about this processor including examples, see parseRoute53.

Link copied to clipboard

This processor converts logs into Open Cybersecurity Schema Framework (OCSF) events.

Link copied to clipboard
class ParseVpc

Use this processor to parse Amazon VPC vended logs, extract fields, and and convert them into a JSON format. This processor always processes the entire log event message.

Link copied to clipboard
class ParseWaf

Use this processor to parse WAF vended logs, extract fields, and and convert them into a JSON format. This processor always processes the entire log event message. For more information about this processor including examples, see parseWAF.

Link copied to clipboard

A structure that contains information about one pattern token related to an anomaly.

Link copied to clipboard
class Policy

A structure that contains information about one delivery destination policy.

Link copied to clipboard
sealed class PolicyScope
Link copied to clipboard
sealed class PolicyType
Link copied to clipboard
class Processor

This structure contains the information about one processor in a log transformer.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Reserved.

Link copied to clipboard
Link copied to clipboard

This structure contains details about a saved CloudWatch Logs Insights query definition.

Link copied to clipboard
class QueryInfo

Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.

Link copied to clipboard
sealed class QueryLanguage
Link copied to clipboard

Contains the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned.

Link copied to clipboard
sealed class QueryStatus
Link copied to clipboard

A structure that represents a valid record field header and whether it is mandatory.

Link copied to clipboard

If an entity is rejected when a PutLogEvents request was made, this includes details about the reason for the rejection.

Link copied to clipboard

Represents the rejected events.

Link copied to clipboard

This object defines one key that will be renamed with the renameKey processor.

Link copied to clipboard

Use this processor to rename keys in a log event.

Link copied to clipboard

The specified resource already exists.

Link copied to clipboard
sealed class ResourceConfig

This structure contains configuration details about an integration between CloudWatch Logs and another entity.

Link copied to clipboard

The specified resource does not exist.

Link copied to clipboard

A policy enabling one or more entities to put logs to a log group in this account.

Link copied to clipboard

Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.

Link copied to clipboard

This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

Link copied to clipboard
sealed class Scope
Link copied to clipboard

Represents the search status of a log stream.

Link copied to clipboard

This request exceeds a service quota.

Link copied to clipboard

The service cannot complete the request.

Link copied to clipboard

This exception is returned if an unknown error occurs during a Live Tail session.

Link copied to clipboard

This exception is returned in a Live Tail stream when the Live Tail session times out. Live Tail sessions time out after three hours.

Link copied to clipboard

Use this processor to split a field into an array of strings using a delimiting character.

Link copied to clipboard

This object defines one log field that will be split with the splitString processor.

Link copied to clipboard
sealed class StandardUnit
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This object includes the stream returned by your StartLiveTail request.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class State
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents a subscription filter.

Link copied to clipboard

This processor matches a key’s value against a regular expression and replaces all matches with a replacement string.

Link copied to clipboard

This object defines one log field key that will be replaced using the substituteString processor.

Link copied to clipboard

If you are suppressing an anomaly temporariliy, this structure defines how long the suppression period is to be.

Link copied to clipboard
sealed class SuppressionState
Link copied to clipboard
sealed class SuppressionType
Link copied to clipboard
sealed class SuppressionUnit
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request was throttled because of quota limits.

Link copied to clipboard

A resource can have no more than 50 tags.

Link copied to clipboard

This structure contains information for one log event that has been processed by a log transformer.

Link copied to clipboard

Use this processor to remove leading and trailing whitespace.

Link copied to clipboard
sealed class Type
Link copied to clipboard

Use this processor to convert a value type associated with the specified key to the specified type. It's a casting processor that changes the types of the specified fields. Values can be converted into one of the following datatypes: integer, double, string and boolean.

Link copied to clipboard

This object defines one value type that will be converted using the typeConverter processor.

Link copied to clipboard

The most likely cause is an Amazon Web Services access key ID or secret key that's not valid.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This processor converts a string field to uppercase.

Link copied to clipboard

One of the parameters for the request is not valid.