package types
import "github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs/types"
Index ¶
- type AccessDeniedException
- func (e *AccessDeniedException) Error() string
- func (e *AccessDeniedException) ErrorCode() string
- func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
- func (e *AccessDeniedException) ErrorMessage() string
- type AccountPolicy
- type AddKeyEntry
- type AddKeys
- type Anomaly
- type AnomalyDetector
- type AnomalyDetectorStatus
- type CSV
- type ConfigurationTemplate
- type ConfigurationTemplateDeliveryConfigValues
- type ConflictException
- func (e *ConflictException) Error() string
- func (e *ConflictException) ErrorCode() string
- func (e *ConflictException) ErrorFault() smithy.ErrorFault
- func (e *ConflictException) ErrorMessage() string
- type CopyValue
- type CopyValueEntry
- type DataAlreadyAcceptedException
- func (e *DataAlreadyAcceptedException) Error() string
- func (e *DataAlreadyAcceptedException) ErrorCode() string
- func (e *DataAlreadyAcceptedException) ErrorFault() smithy.ErrorFault
- func (e *DataAlreadyAcceptedException) ErrorMessage() string
- type DataProtectionStatus
- type DateTimeConverter
- type DeleteKeys
- type Delivery
- type DeliveryDestination
- type DeliveryDestinationConfiguration
- type DeliveryDestinationType
- type DeliverySource
- type Destination
- type Distribution
- type Entity
- type EntityRejectionErrorType
- type EvaluationFrequency
- type ExportTask
- type ExportTaskExecutionInfo
- type ExportTaskStatus
- type ExportTaskStatusCode
- type FieldIndex
- type FilteredLogEvent
- type FlattenedElement
- type Grok
- type IndexPolicy
- type IndexSource
- type InheritedProperty
- type InputLogEvent
- type IntegrationDetails
- type IntegrationDetailsMemberOpenSearchIntegrationDetails
- type IntegrationStatus
- type IntegrationSummary
- type IntegrationType
- type InvalidOperationException
- func (e *InvalidOperationException) Error() string
- func (e *InvalidOperationException) ErrorCode() string
- func (e *InvalidOperationException) ErrorFault() smithy.ErrorFault
- func (e *InvalidOperationException) ErrorMessage() string
- type InvalidParameterException
- func (e *InvalidParameterException) Error() string
- func (e *InvalidParameterException) ErrorCode() string
- func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault
- func (e *InvalidParameterException) ErrorMessage() string
- type InvalidSequenceTokenException
- func (e *InvalidSequenceTokenException) Error() string
- func (e *InvalidSequenceTokenException) ErrorCode() string
- func (e *InvalidSequenceTokenException) ErrorFault() smithy.ErrorFault
- func (e *InvalidSequenceTokenException) ErrorMessage() string
- type LimitExceededException
- func (e *LimitExceededException) Error() string
- func (e *LimitExceededException) ErrorCode() string
- func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
- func (e *LimitExceededException) ErrorMessage() string
- type ListToMap
- type LiveTailSessionLogEvent
- type LiveTailSessionMetadata
- type LiveTailSessionStart
- type LiveTailSessionUpdate
- type LogEvent
- type LogGroup
- type LogGroupClass
- type LogGroupField
- type LogStream
- type LowerCaseString
- type MalformedQueryException
- func (e *MalformedQueryException) Error() string
- func (e *MalformedQueryException) ErrorCode() string
- func (e *MalformedQueryException) ErrorFault() smithy.ErrorFault
- func (e *MalformedQueryException) ErrorMessage() string
- type MetricFilter
- type MetricFilterMatchRecord
- type MetricTransformation
- type MoveKeyEntry
- type MoveKeys
- type OpenSearchApplication
- type OpenSearchCollection
- type OpenSearchDataAccessPolicy
- type OpenSearchDataSource
- type OpenSearchEncryptionPolicy
- type OpenSearchIntegrationDetails
- type OpenSearchLifecyclePolicy
- type OpenSearchNetworkPolicy
- type OpenSearchResourceConfig
- type OpenSearchResourceStatus
- type OpenSearchResourceStatusType
- type OpenSearchWorkspace
- type OperationAbortedException
- func (e *OperationAbortedException) Error() string
- func (e *OperationAbortedException) ErrorCode() string
- func (e *OperationAbortedException) ErrorFault() smithy.ErrorFault
- func (e *OperationAbortedException) ErrorMessage() string
- type OrderBy
- type OutputFormat
- type OutputLogEvent
- type ParseCloudfront
- type ParseJSON
- type ParseKeyValue
- type ParsePostgres
- type ParseRoute53
- type ParseVPC
- type ParseWAF
- type PatternToken
- type Policy
- type PolicyType
- type Processor
- type QueryCompileError
- type QueryCompileErrorLocation
- type QueryDefinition
- type QueryInfo
- type QueryLanguage
- type QueryStatistics
- type QueryStatus
- type RecordField
- type RejectedEntityInfo
- type RejectedLogEventsInfo
- type RenameKeyEntry
- type RenameKeys
- type ResourceAlreadyExistsException
- func (e *ResourceAlreadyExistsException) Error() string
- func (e *ResourceAlreadyExistsException) ErrorCode() string
- func (e *ResourceAlreadyExistsException) ErrorFault() smithy.ErrorFault
- func (e *ResourceAlreadyExistsException) ErrorMessage() string
- type ResourceConfig
- type ResourceConfigMemberOpenSearchResourceConfig
- type ResourceNotFoundException
- func (e *ResourceNotFoundException) Error() string
- func (e *ResourceNotFoundException) ErrorCode() string
- func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *ResourceNotFoundException) ErrorMessage() string
- type ResourcePolicy
- type ResultField
- type S3DeliveryConfiguration
- type Scope
- type SearchedLogStream
- type ServiceQuotaExceededException
- func (e *ServiceQuotaExceededException) Error() string
- func (e *ServiceQuotaExceededException) ErrorCode() string
- func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
- func (e *ServiceQuotaExceededException) ErrorMessage() string
- type ServiceUnavailableException
- func (e *ServiceUnavailableException) Error() string
- func (e *ServiceUnavailableException) ErrorCode() string
- func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault
- func (e *ServiceUnavailableException) ErrorMessage() string
- type SessionStreamingException
- func (e *SessionStreamingException) Error() string
- func (e *SessionStreamingException) ErrorCode() string
- func (e *SessionStreamingException) ErrorFault() smithy.ErrorFault
- func (e *SessionStreamingException) ErrorMessage() string
- type SessionTimeoutException
- func (e *SessionTimeoutException) Error() string
- func (e *SessionTimeoutException) ErrorCode() string
- func (e *SessionTimeoutException) ErrorFault() smithy.ErrorFault
- func (e *SessionTimeoutException) ErrorMessage() string
- type SplitString
- type SplitStringEntry
- type StandardUnit
- type StartLiveTailResponseStream
- type StartLiveTailResponseStreamMemberSessionStart
- type StartLiveTailResponseStreamMemberSessionUpdate
- type State
- type SubscriptionFilter
- type SubstituteString
- type SubstituteStringEntry
- type SuppressionPeriod
- type SuppressionState
- type SuppressionType
- type SuppressionUnit
- type ThrottlingException
- func (e *ThrottlingException) Error() string
- func (e *ThrottlingException) ErrorCode() string
- func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
- func (e *ThrottlingException) ErrorMessage() string
- type TooManyTagsException
- func (e *TooManyTagsException) Error() string
- func (e *TooManyTagsException) ErrorCode() string
- func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault
- func (e *TooManyTagsException) ErrorMessage() string
- type TransformedLogRecord
- type TrimString
- type Type
- type TypeConverter
- type TypeConverterEntry
- type UnknownUnionMember
- type UnrecognizedClientException
- func (e *UnrecognizedClientException) Error() string
- func (e *UnrecognizedClientException) ErrorCode() string
- func (e *UnrecognizedClientException) ErrorFault() smithy.ErrorFault
- func (e *UnrecognizedClientException) ErrorMessage() string
- type UpperCaseString
- type ValidationException
Examples ¶
- IntegrationDetails (OutputUsage)
- ResourceConfig (OutputUsage)
- StartLiveTailResponseStream (OutputUsage)
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
You don't have sufficient permissions to perform this action.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type AccountPolicy ¶
type AccountPolicy struct { // The Amazon Web Services account ID that the policy applies to. AccountId *string // The date and time that this policy was most recently updated. LastUpdatedTime *int64 // The policy document for this account policy. // // The JSON specified in policyDocument can be up to 30,720 characters. PolicyDocument *string // The name of the account policy. PolicyName *string // The type of policy for this account policy. PolicyType PolicyType // The scope of the account policy. Scope Scope // The log group selection criteria that is used for this policy. SelectionCriteria *string // contains filtered or unexported fields }
A structure that contains information about one CloudWatch Logs account policy.
type AddKeyEntry ¶
type AddKeyEntry struct { // The key of the new entry to be added to the log event // // This member is required. Key *string // The value of the new entry to be added to the log event // // This member is required. Value *string // Specifies whether to overwrite the value if the key already exists in the log // event. If you omit this, the default is false . OverwriteIfExists bool // contains filtered or unexported fields }
This object defines one key that will be added with the addKeys processor.
type AddKeys ¶
type AddKeys struct { // An array of objects, where each object contains the information about one key // to add to the log event. // // This member is required. Entries []AddKeyEntry // contains filtered or unexported fields }
This processor adds new key-value pairs to the log event.
For more information about this processor including examples, see addKeys in the CloudWatch Logs User Guide.
type Anomaly ¶
type Anomaly struct { // Specifies whether this anomaly is still ongoing. // // This member is required. Active *bool // The ARN of the anomaly detector that identified this anomaly. // // This member is required. AnomalyDetectorArn *string // The unique ID that CloudWatch Logs assigned to this anomaly. // // This member is required. AnomalyId *string // A human-readable description of the anomaly. This description is generated by // CloudWatch Logs. // // This member is required. Description *string // The date and time when the anomaly detector first saw this anomaly. It is // specified as epoch time, which is the number of seconds since January 1, 1970, // 00:00:00 UTC . // // This member is required. FirstSeen int64 // A map showing times when the anomaly detector ran, and the number of // occurrences of this anomaly that were detected at each of those runs. The times // are specified in epoch time, which is the number of seconds since January 1, // 1970, 00:00:00 UTC . // // This member is required. Histogram map[string]int64 // The date and time when the anomaly detector most recently saw this anomaly. It // is specified as epoch time, which is the number of seconds since January 1, // 1970, 00:00:00 UTC . // // This member is required. LastSeen int64 // An array of ARNS of the log groups that contained log events considered to be // part of this anomaly. // // This member is required. LogGroupArnList []string // An array of sample log event messages that are considered to be part of this // anomaly. // // This member is required. LogSamples []LogEvent // The ID of the pattern used to help identify this anomaly. // // This member is required. PatternId *string // The pattern used to help identify this anomaly, in string format. // // This member is required. PatternString *string // An array of structures where each structure contains information about one // token that makes up the pattern. // // This member is required. PatternTokens []PatternToken // Indicates the current state of this anomaly. If it is still being treated as an // anomaly, the value is Active . If you have suppressed this anomaly by using the [UpdateAnomaly] // operation, the value is Suppressed . If this behavior is now considered to be // normal, the value is Baseline . // // [UpdateAnomaly]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html // // This member is required. State State // If this anomaly is suppressed, this field is true if the suppression is because // the pattern is suppressed. If false , then only this particular anomaly is // suppressed. IsPatternLevelSuppression *bool // The pattern used to help identify this anomaly, in regular expression format. PatternRegex *string // The priority level of this anomaly, as determined by CloudWatch Logs. Priority // is computed based on log severity labels such as FATAL and ERROR and the amount // of deviation from the baseline. Possible values are HIGH , MEDIUM , and LOW . Priority *string // Indicates whether this anomaly is currently suppressed. To suppress an anomaly, // use [UpdateAnomaly]. // // [UpdateAnomaly]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html Suppressed *bool // If the anomaly is suppressed, this indicates when it was suppressed. SuppressedDate int64 // If the anomaly is suppressed, this indicates when the suppression will end. If // this value is 0 , the anomaly was suppressed with no expiration, with the // INFINITE value. SuppressedUntil int64 // contains filtered or unexported fields }
This structure represents one anomaly that has been found by a logs anomaly detector.
For more information about patterns and anomalies, see CreateLogAnomalyDetector.
type AnomalyDetector ¶
type AnomalyDetector struct { // The ARN of the anomaly detector. AnomalyDetectorArn *string // Specifies the current status of the anomaly detector. To pause an anomaly // detector, use the enabled parameter in the [UpdateLogAnomalyDetector] operation. // // [UpdateLogAnomalyDetector]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html AnomalyDetectorStatus AnomalyDetectorStatus // The number of days used as the life cycle of anomalies. After this time, // anomalies are automatically baselined and the anomaly detector model will treat // new occurrences of similar event as normal. AnomalyVisibilityTime *int64 // The date and time when this anomaly detector was created. CreationTimeStamp int64 // The name of the anomaly detector. DetectorName *string // Specifies how often the anomaly detector runs and look for anomalies. EvaluationFrequency EvaluationFrequency // A symbolic description of how CloudWatch Logs should interpret the data in each // log event. For example, a log event can contain timestamps, IP addresses, // strings, and so on. You use the filter pattern to specify what to look for in // the log event message. FilterPattern *string // The ARN of the KMS key assigned to this anomaly detector, if any. KmsKeyId *string // The date and time when this anomaly detector was most recently modified. LastModifiedTimeStamp int64 // A list of the ARNs of the log groups that this anomaly detector watches. LogGroupArnList []string // contains filtered or unexported fields }
Contains information about one anomaly detector in the account.
type AnomalyDetectorStatus ¶
type AnomalyDetectorStatus string
const ( AnomalyDetectorStatusInitializing AnomalyDetectorStatus = "INITIALIZING" AnomalyDetectorStatusTraining AnomalyDetectorStatus = "TRAINING" AnomalyDetectorStatusAnalyzing AnomalyDetectorStatus = "ANALYZING" AnomalyDetectorStatusFailed AnomalyDetectorStatus = "FAILED" AnomalyDetectorStatusDeleted AnomalyDetectorStatus = "DELETED" AnomalyDetectorStatusPaused AnomalyDetectorStatus = "PAUSED" )
Enum values for AnomalyDetectorStatus
func (AnomalyDetectorStatus) Values ¶
func (AnomalyDetectorStatus) Values() []AnomalyDetectorStatus
Values returns all known values for AnomalyDetectorStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type CSV ¶
type CSV struct { // An array of names to use for the columns in the transformed log event. // // If you omit this, default column names ( [column_1, column_2 ...] ) are used. Columns []string // The character used to separate each column in the original comma-separated // value log event. If you omit this, the processor looks for the comma , // character as the delimiter. Delimiter *string // The character used used as a text qualifier for a single column of data. If you // omit this, the double quotation mark " character is used. QuoteCharacter *string // The path to the field in the log event that has the comma separated values to // be parsed. If you omit this value, the whole log message is processed. Source *string // contains filtered or unexported fields }
The CSV processor parses comma-separated values (CSV) from the log events into columns.
For more information about this processor including examples, see csv in the CloudWatch Logs User Guide.
type ConfigurationTemplate ¶
type ConfigurationTemplate struct { // The action permissions that a caller needs to have to be able to successfully // create a delivery source on the desired resource type when calling [PutDeliverySource]. // // [PutDeliverySource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html AllowedActionForAllowVendedLogsDeliveryForResource *string // The valid values that a caller can use as field delimiters when calling [CreateDelivery] or [UpdateDeliveryConfiguration] on // a delivery that delivers in Plain , W3C , or Raw format. // // [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html // [UpdateDeliveryConfiguration]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html AllowedFieldDelimiters []string // The allowed fields that a caller can use in the recordFields parameter of a [CreateDelivery] or [UpdateDeliveryConfiguration] // operation. // // [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html // [UpdateDeliveryConfiguration]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html AllowedFields []RecordField // The list of delivery destination output formats that are supported by this log // source. AllowedOutputFormats []OutputFormat // The list of variable fields that can be used in the suffix path of a delivery // that delivers to an S3 bucket. AllowedSuffixPathFields []string // A mapping that displays the default value of each property within a delivery's // configuration, if it is not specified in the request. DefaultDeliveryConfigValues *ConfigurationTemplateDeliveryConfigValues // A string specifying which destination type this configuration template applies // to. DeliveryDestinationType DeliveryDestinationType // A string specifying which log type this configuration template applies to. LogType *string // A string specifying which resource type this configuration template applies to. ResourceType *string // A string specifying which service this configuration template applies to. For // more information about supported services see [Enable logging from Amazon Web Services services.]. // // [Enable logging from Amazon Web Services services.]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html Service *string // contains filtered or unexported fields }
A structure containing information about the deafult settings and available settings that you can use to configure a deliveryor a delivery destination.
type ConfigurationTemplateDeliveryConfigValues ¶
type ConfigurationTemplateDeliveryConfigValues struct { // The default field delimiter that is used in a [CreateDelivery] operation when the field // delimiter is not specified in that operation. The field delimiter is used only // when the final output delivery is in Plain , W3C , or Raw format. // // [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html FieldDelimiter *string // The default record fields that will be delivered when a list of record fields // is not provided in a [CreateDelivery]operation. // // [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html RecordFields []string // The delivery parameters that are used when you create a delivery to a delivery // destination that is an S3 Bucket. S3DeliveryConfiguration *S3DeliveryConfiguration // contains filtered or unexported fields }
This structure contains the default values that are used for each configuration parameter when you use CreateDeliveryto create a deliver under the current service type, resource type, and log type.
type ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
This operation attempted to create a resource that already exists.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type CopyValue ¶
type CopyValue struct { // An array of CopyValueEntry objects, where each object contains the information // about one field value to copy. // // This member is required. Entries []CopyValueEntry // contains filtered or unexported fields }
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 .
For more information about this processor including examples, see copyValue in the CloudWatch Logs User Guide.
type CopyValueEntry ¶
type CopyValueEntry struct { // The key to copy. // // This member is required. Source *string // The key of the field to copy the value to. // // This member is required. Target *string // Specifies whether to overwrite the value if the destination key already exists. // If you omit this, the default is false . OverwriteIfExists bool // contains filtered or unexported fields }
This object defines one value to be copied with the copyValue processor.
type DataAlreadyAcceptedException ¶
type DataAlreadyAcceptedException struct { Message *string ErrorCodeOverride *string ExpectedSequenceToken *string // contains filtered or unexported fields }
The event was already logged.
PutLogEvents actions are now always accepted and never return DataAlreadyAcceptedException regardless of whether a given batch of log events has already been accepted.
func (*DataAlreadyAcceptedException) Error ¶
func (e *DataAlreadyAcceptedException) Error() string
func (*DataAlreadyAcceptedException) ErrorCode ¶
func (e *DataAlreadyAcceptedException) ErrorCode() string
func (*DataAlreadyAcceptedException) ErrorFault ¶
func (e *DataAlreadyAcceptedException) ErrorFault() smithy.ErrorFault
func (*DataAlreadyAcceptedException) ErrorMessage ¶
func (e *DataAlreadyAcceptedException) ErrorMessage() string
type DataProtectionStatus ¶
type DataProtectionStatus string
const ( DataProtectionStatusActivated DataProtectionStatus = "ACTIVATED" DataProtectionStatusDeleted DataProtectionStatus = "DELETED" DataProtectionStatusArchived DataProtectionStatus = "ARCHIVED" DataProtectionStatusDisabled DataProtectionStatus = "DISABLED" )
Enum values for DataProtectionStatus
func (DataProtectionStatus) Values ¶
func (DataProtectionStatus) Values() []DataProtectionStatus
Values returns all known values for DataProtectionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DateTimeConverter ¶
type DateTimeConverter struct { // A list of patterns to match against the source field. // // This member is required. MatchPatterns []string // The key to apply the date conversion to. // // This member is required. Source *string // The JSON field to store the result in. // // This member is required. Target *string // The locale of the source field. If you omit this, the default of locale.ROOT is // used. Locale *string // The time zone of the source field. If you omit this, the default used is the // UTC zone. SourceTimezone *string // The datetime format to use for the converted data in the target field. // // If you omit this, the default of yyyy-MM-dd'T'HH:mm:ss.SSS'Z is used. TargetFormat *string // The time zone of the target field. If you omit this, the default used is the // UTC zone. TargetTimezone *string // contains filtered or unexported fields }
This processor converts a datetime string into a format that you specify.
For more information about this processor including examples, see datetimeConverter in the CloudWatch Logs User Guide.
type DeleteKeys ¶
type DeleteKeys struct { // The list of keys to delete. // // This member is required. WithKeys []string // contains filtered or unexported fields }
This processor deletes entries from a log event. These entries are key-value pairs.
For more information about this processor including examples, see deleteKeys in the CloudWatch Logs User Guide.
type Delivery ¶
type Delivery struct { // The Amazon Resource Name (ARN) that uniquely identifies this delivery. Arn *string // The ARN of the delivery destination that is associated with this delivery. DeliveryDestinationArn *string // Displays whether the delivery destination associated with this delivery is // CloudWatch Logs, Amazon S3, or Firehose. DeliveryDestinationType DeliveryDestinationType // The name of the delivery source that is associated with this delivery. DeliverySourceName *string // The field delimiter that is used between record fields when the final output // format of a delivery is in Plain , W3C , or Raw format. FieldDelimiter *string // The unique ID that identifies this delivery in your account. Id *string // The record fields used in this delivery. RecordFields []string // This structure contains delivery configurations that apply only when the // delivery destination resource is an S3 bucket. S3DeliveryConfiguration *S3DeliveryConfiguration // The tags that have been assigned to this delivery. Tags map[string]string // contains filtered or unexported fields }
This structure contains information about one delivery in your account.
A delivery is a connection between a logical delivery source and a logical delivery destination.
For more information, see CreateDelivery.
To update an existing delivery configuration, use UpdateDeliveryConfiguration.
type DeliveryDestination ¶
type DeliveryDestination struct { // The Amazon Resource Name (ARN) that uniquely identifies this delivery // destination. Arn *string // A structure that contains the ARN of the Amazon Web Services resource that will // receive the logs. DeliveryDestinationConfiguration *DeliveryDestinationConfiguration // Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or // Firehose. DeliveryDestinationType DeliveryDestinationType // The name of this delivery destination. Name *string // The format of the logs that are sent to this delivery destination. OutputFormat OutputFormat // The tags that have been assigned to this delivery destination. Tags map[string]string // contains filtered or unexported fields }
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, are supported as Firehose delivery destinations.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination.
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicyin the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
type DeliveryDestinationConfiguration ¶
type DeliveryDestinationConfiguration struct { // The ARN of the Amazon Web Services destination that this delivery destination // represents. That Amazon Web Services destination can be a log group in // CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose. // // This member is required. DestinationResourceArn *string // contains filtered or unexported fields }
A structure that contains information about one logs delivery destination.
type DeliveryDestinationType ¶
type DeliveryDestinationType string
const ( DeliveryDestinationTypeS3 DeliveryDestinationType = "S3" DeliveryDestinationTypeCwl DeliveryDestinationType = "CWL" DeliveryDestinationTypeFh DeliveryDestinationType = "FH" )
Enum values for DeliveryDestinationType
func (DeliveryDestinationType) Values ¶
func (DeliveryDestinationType) Values() []DeliveryDestinationType
Values returns all known values for DeliveryDestinationType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DeliverySource ¶
type DeliverySource struct { // The Amazon Resource Name (ARN) that uniquely identifies this delivery source. Arn *string // The type of log that the source is sending. For valid values for this // parameter, see the documentation for the source service. LogType *string // The unique name of the delivery source. Name *string // This array contains the ARN of the Amazon Web Services resource that sends logs // and is represented by this delivery source. Currently, only one ARN can be in // the array. ResourceArns []string // The Amazon Web Services service that is sending logs. Service *string // The tags that have been assigned to this delivery source. Tags map[string]string // contains filtered or unexported fields }
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.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicyin the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
type Destination ¶
type Destination struct { // An IAM policy document that governs which Amazon Web Services accounts can // create subscription filters against this destination. AccessPolicy *string // The ARN of this destination. Arn *string // The creation time of the destination, expressed as the number of milliseconds // after Jan 1, 1970 00:00:00 UTC. CreationTime *int64 // The name of the destination. DestinationName *string // A role for impersonation, used when delivering log events to the target. RoleArn *string // The Amazon Resource Name (ARN) of the physical target where the log events are // delivered (for example, a Kinesis stream). TargetArn *string // contains filtered or unexported fields }
Represents a cross-account destination that receives subscription log events.
type Distribution ¶
type Distribution string
const ( DistributionRandom Distribution = "Random" DistributionByLogStream Distribution = "ByLogStream" )
Enum values for Distribution
func (Distribution) Values ¶
func (Distribution) Values() []Distribution
Values returns all known values for Distribution. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Entity ¶
type Entity struct { // Additional attributes of the entity that are not used to specify the identity // of the entity. A list of key-value pairs. // // For details about how to use the attributes, see [How to add related information to telemetry] in the CloudWatch User Guide. // // [How to add related information to telemetry]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html Attributes map[string]string // The attributes of the entity which identify the specific entity, as a list of // key-value pairs. Entities with the same keyAttributes are considered to be the // same entity. // // There are five allowed attributes (key names): Type , ResourceType , Identifier // Name , and Environment . // // For details about how to use the key attributes, see [How to add related information to telemetry] in the CloudWatch User // Guide. // // [How to add related information to telemetry]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html KeyAttributes map[string]string // contains filtered or unexported fields }
The entity associated with the log events in a PutLogEvents call.
type EntityRejectionErrorType ¶
type EntityRejectionErrorType string
const ( EntityRejectionErrorTypeInvalidEntity EntityRejectionErrorType = "InvalidEntity" EntityRejectionErrorTypeInvalidTypeValue EntityRejectionErrorType = "InvalidTypeValue" EntityRejectionErrorTypeInvalidKeyAttribute EntityRejectionErrorType = "InvalidKeyAttributes" EntityRejectionErrorTypeInvalidAttributes EntityRejectionErrorType = "InvalidAttributes" EntityRejectionErrorTypeEntitySizeTooLarge EntityRejectionErrorType = "EntitySizeTooLarge" EntityRejectionErrorTypeUnsupportedLogGroupType EntityRejectionErrorType = "UnsupportedLogGroupType" EntityRejectionErrorTypeMissingRequiredFields EntityRejectionErrorType = "MissingRequiredFields" )
Enum values for EntityRejectionErrorType
func (EntityRejectionErrorType) Values ¶
func (EntityRejectionErrorType) Values() []EntityRejectionErrorType
Values returns all known values for EntityRejectionErrorType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EvaluationFrequency ¶
type EvaluationFrequency string
const ( EvaluationFrequencyOneMin EvaluationFrequency = "ONE_MIN" EvaluationFrequencyFiveMin EvaluationFrequency = "FIVE_MIN" EvaluationFrequencyTenMin EvaluationFrequency = "TEN_MIN" EvaluationFrequencyFifteenMin EvaluationFrequency = "FIFTEEN_MIN" EvaluationFrequencyThirtyMin EvaluationFrequency = "THIRTY_MIN" EvaluationFrequencyOneHour EvaluationFrequency = "ONE_HOUR" )
Enum values for EvaluationFrequency
func (EvaluationFrequency) Values ¶
func (EvaluationFrequency) Values() []EvaluationFrequency
Values returns all known values for EvaluationFrequency. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ExportTask ¶
type ExportTask struct { // The name of the S3 bucket to which the log data was exported. Destination *string // The prefix that was used as the start of Amazon S3 key for every object // exported. DestinationPrefix *string // Execution information about the export task. ExecutionInfo *ExportTaskExecutionInfo // The start time, expressed as the number of milliseconds after Jan 1, 1970 // 00:00:00 UTC . Events with a timestamp before this time are not exported. From *int64 // The name of the log group from which logs data was exported. LogGroupName *string // The status of the export task. Status *ExportTaskStatus // The ID of the export task. TaskId *string // The name of the export task. TaskName *string // The end time, expressed as the number of milliseconds after Jan 1, 1970 // 00:00:00 UTC . Events with a timestamp later than this time are not exported. To *int64 // contains filtered or unexported fields }
Represents an export task.
type ExportTaskExecutionInfo ¶
type ExportTaskExecutionInfo struct { // The completion time of the export task, expressed as the number of milliseconds // after Jan 1, 1970 00:00:00 UTC . CompletionTime *int64 // The creation time of the export task, expressed as the number of milliseconds // after Jan 1, 1970 00:00:00 UTC . CreationTime *int64 // contains filtered or unexported fields }
Represents the status of an export task.
type ExportTaskStatus ¶
type ExportTaskStatus struct { // The status code of the export task. Code ExportTaskStatusCode // The status message related to the status code. Message *string // contains filtered or unexported fields }
Represents the status of an export task.
type ExportTaskStatusCode ¶
type ExportTaskStatusCode string
const ( ExportTaskStatusCodeCancelled ExportTaskStatusCode = "CANCELLED" ExportTaskStatusCodeCompleted ExportTaskStatusCode = "COMPLETED" ExportTaskStatusCodeFailed ExportTaskStatusCode = "FAILED" ExportTaskStatusCodePending ExportTaskStatusCode = "PENDING" ExportTaskStatusCodePendingCancel ExportTaskStatusCode = "PENDING_CANCEL" ExportTaskStatusCodeRunning ExportTaskStatusCode = "RUNNING" )
Enum values for ExportTaskStatusCode
func (ExportTaskStatusCode) Values ¶
func (ExportTaskStatusCode) Values() []ExportTaskStatusCode
Values returns all known values for ExportTaskStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type FieldIndex ¶
type FieldIndex struct { // The string that this field index matches. FieldIndexName *string // The time and date of the earliest log event that matches this field index, // after the index policy that contains it was created. FirstEventTime *int64 // The time and date of the most recent log event that matches this field index. LastEventTime *int64 // The most recent time that CloudWatch Logs scanned ingested log events to search // for this field index to improve the speed of future CloudWatch Logs Insights // queries that search for this field index. LastScanTime *int64 // If this field index appears in an index policy that applies only to a single // log group, the ARN of that log group is displayed here. LogGroupIdentifier *string // contains filtered or unexported fields }
This structure describes one log event field that is used as an index in at least one index policy in this account.
type FilteredLogEvent ¶
type FilteredLogEvent struct { // The ID of the event. EventId *string // The time the event was ingested, expressed as the number of milliseconds after // Jan 1, 1970 00:00:00 UTC . IngestionTime *int64 // The name of the log stream to which this event belongs. LogStreamName *string // The data contained in the log event. Message *string // The time the event occurred, expressed as the number of milliseconds after Jan // 1, 1970 00:00:00 UTC . Timestamp *int64 // contains filtered or unexported fields }
Represents a matched event.
type FlattenedElement ¶
type FlattenedElement string
const ( FlattenedElementFirst FlattenedElement = "first" FlattenedElementLast FlattenedElement = "last" )
Enum values for FlattenedElement
func (FlattenedElement) Values ¶
func (FlattenedElement) Values() []FlattenedElement
Values returns all known values for FlattenedElement. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Grok ¶
type Grok struct { // The grok pattern to match against the log event. For a list of supported grok // patterns, see [Supported grok patterns]. // // [Supported grok patterns]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#Grok-Patterns // // This member is required. Match *string // The path to the field in the log event that you want to parse. If you omit this // value, the whole log message is parsed. Source *string // contains filtered or unexported fields }
This processor uses pattern matching to parse and structure unstructured data. This processor can also extract fields from log messages.
For more information about this processor including examples, see grok in the CloudWatch Logs User Guide.
type IndexPolicy ¶
type IndexPolicy struct { // The date and time that this index policy was most recently updated. LastUpdateTime *int64 // The ARN of the log group that this index policy applies to. LogGroupIdentifier *string // The policy document for this index policy, in JSON format. PolicyDocument *string // The name of this policy. Responses about log group-level field index policies // don't have this field, because those policies don't have names. PolicyName *string // This field indicates whether this is an account-level index policy or an index // policy that applies only to a single log group. Source IndexSource // contains filtered or unexported fields }
This structure contains information about one field index policy in this account.
type IndexSource ¶
type IndexSource string
const ( IndexSourceAccount IndexSource = "ACCOUNT" IndexSourceLogGroup IndexSource = "LOG_GROUP" )
Enum values for IndexSource
func (IndexSource) Values ¶
func (IndexSource) Values() []IndexSource
Values returns all known values for IndexSource. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InheritedProperty ¶
type InheritedProperty string
const ( InheritedPropertyAccountDataProtection InheritedProperty = "ACCOUNT_DATA_PROTECTION" )
Enum values for InheritedProperty
func (InheritedProperty) Values ¶
func (InheritedProperty) Values() []InheritedProperty
Values returns all known values for InheritedProperty. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InputLogEvent ¶
type InputLogEvent struct { // The raw event message. Each log event can be no larger than 256 KB. // // This member is required. Message *string // The time the event occurred, expressed as the number of milliseconds after Jan // 1, 1970 00:00:00 UTC . // // This member is required. Timestamp *int64 // contains filtered or unexported fields }
Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.
type IntegrationDetails ¶
type IntegrationDetails interface {
// contains filtered or unexported methods
}
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.
This structure is returned by a GetIntegration operation.
The following types satisfy this interface:
IntegrationDetailsMemberOpenSearchIntegrationDetails
Example (OutputUsage)¶
Code:play
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs/types" ) func main() { var union types.IntegrationDetails // type switches can be used to check the union value switch v := union.(type) { case *types.IntegrationDetailsMemberOpenSearchIntegrationDetails: _ = v.Value // Value is types.OpenSearchIntegrationDetails case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
type IntegrationDetailsMemberOpenSearchIntegrationDetails ¶
type IntegrationDetailsMemberOpenSearchIntegrationDetails struct { Value OpenSearchIntegrationDetails // contains filtered or unexported fields }
This structure contains complete information about one integration between CloudWatch Logs and OpenSearch Service.
type IntegrationStatus ¶
type IntegrationStatus string
const ( IntegrationStatusProvisioning IntegrationStatus = "PROVISIONING" IntegrationStatusActive IntegrationStatus = "ACTIVE" IntegrationStatusFailed IntegrationStatus = "FAILED" )
Enum values for IntegrationStatus
func (IntegrationStatus) Values ¶
func (IntegrationStatus) Values() []IntegrationStatus
Values returns all known values for IntegrationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type IntegrationSummary ¶
type IntegrationSummary struct { // The name of this integration. IntegrationName *string // The current status of this integration. IntegrationStatus IntegrationStatus // The type of integration. Integrations with OpenSearch Service have the type // OPENSEARCH . IntegrationType IntegrationType // contains filtered or unexported fields }
This structure contains information about one CloudWatch Logs integration. This structure is returned by a ListIntegrationsoperation.
type IntegrationType ¶
type IntegrationType string
const ( IntegrationTypeOpensearch IntegrationType = "OPENSEARCH" )
Enum values for IntegrationType
func (IntegrationType) Values ¶
func (IntegrationType) Values() []IntegrationType
Values returns all known values for IntegrationType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InvalidOperationException ¶
type InvalidOperationException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The operation is not valid on the specified resource.
func (*InvalidOperationException) Error ¶
func (e *InvalidOperationException) Error() string
func (*InvalidOperationException) ErrorCode ¶
func (e *InvalidOperationException) ErrorCode() string
func (*InvalidOperationException) ErrorFault ¶
func (e *InvalidOperationException) ErrorFault() smithy.ErrorFault
func (*InvalidOperationException) ErrorMessage ¶
func (e *InvalidOperationException) ErrorMessage() string
type InvalidParameterException ¶
type InvalidParameterException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
A parameter is specified incorrectly.
func (*InvalidParameterException) Error ¶
func (e *InvalidParameterException) Error() string
func (*InvalidParameterException) ErrorCode ¶
func (e *InvalidParameterException) ErrorCode() string
func (*InvalidParameterException) ErrorFault ¶
func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault
func (*InvalidParameterException) ErrorMessage ¶
func (e *InvalidParameterException) ErrorMessage() string
type InvalidSequenceTokenException ¶
type InvalidSequenceTokenException struct { Message *string ErrorCodeOverride *string ExpectedSequenceToken *string // contains filtered or unexported fields }
The sequence token is not valid. You can get the correct sequence token in the expectedSequenceToken field in the InvalidSequenceTokenException message.
PutLogEvents actions are now always accepted and never return InvalidSequenceTokenException regardless of receiving an invalid sequence token.
func (*InvalidSequenceTokenException) Error ¶
func (e *InvalidSequenceTokenException) Error() string
func (*InvalidSequenceTokenException) ErrorCode ¶
func (e *InvalidSequenceTokenException) ErrorCode() string
func (*InvalidSequenceTokenException) ErrorFault ¶
func (e *InvalidSequenceTokenException) ErrorFault() smithy.ErrorFault
func (*InvalidSequenceTokenException) ErrorMessage ¶
func (e *InvalidSequenceTokenException) ErrorMessage() string
type LimitExceededException ¶
type LimitExceededException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
You have reached the maximum number of resources that can be created.
func (*LimitExceededException) Error ¶
func (e *LimitExceededException) Error() string
func (*LimitExceededException) ErrorCode ¶
func (e *LimitExceededException) ErrorCode() string
func (*LimitExceededException) ErrorFault ¶
func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
func (*LimitExceededException) ErrorMessage ¶
func (e *LimitExceededException) ErrorMessage() string
type ListToMap ¶
type ListToMap struct { // The key of the field to be extracted as keys in the generated map // // This member is required. Key *string // The key in the log event that has a list of objects that will be converted to a // map. // // This member is required. Source *string // A Boolean value to indicate whether the list will be flattened into single // items. Specify true to flatten the list. The default is false Flatten bool // If you set flatten to true , use flattenedElement to specify which element, // first or last , to keep. // // You must specify this parameter if flatten is true FlattenedElement FlattenedElement // The key of the field that will hold the generated map Target *string // If this is specified, the values that you specify in this parameter will be // extracted from the source objects and put into the values of the generated map. // Otherwise, original objects in the source list will be put into the values of // the generated map. ValueKey *string // contains filtered or unexported fields }
This processor takes a list of objects that contain key fields, and converts them into a map of target keys.
For more information about this processor including examples, see listToMap in the CloudWatch Logs User Guide.
type LiveTailSessionLogEvent ¶
type LiveTailSessionLogEvent struct { // The timestamp specifying when this log event was ingested into the log group. IngestionTime *int64 // The name or ARN of the log group that ingested this log event. LogGroupIdentifier *string // The name of the log stream that ingested this log event. LogStreamName *string // The log event message text. Message *string // The timestamp specifying when this log event was created. Timestamp *int64 // contains filtered or unexported fields }
This object contains the information for one log event returned in a Live Tail stream.
type LiveTailSessionMetadata ¶
type LiveTailSessionMetadata struct { // If this is true , then more than 500 log events matched the request for this // update, and the sessionResults includes a sample of 500 of those events. // // If this is false , then 500 or fewer log events matched the request for this // update, so no sampling was necessary. In this case, the sessionResults array // includes all log events that matched your request during this time. Sampled bool // contains filtered or unexported fields }
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.
type LiveTailSessionStart ¶
type LiveTailSessionStart struct { // An optional pattern to filter the results to include only log events that match // the pattern. For example, a filter pattern of error 404 displays only log // events that include both error and 404 . // // For more information about filter pattern syntax, see [Filter and Pattern Syntax]. // // [Filter and Pattern Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html LogEventFilterPattern *string // An array of the names and ARNs of the log groups included in this Live Tail // session. LogGroupIdentifiers []string // If your StartLiveTail operation request included a logStreamNamePrefixes // parameter that filtered the session to only include log streams that have names // that start with certain prefixes, these prefixes are listed here. LogStreamNamePrefixes []string // If your StartLiveTail operation request included a logStreamNames parameter // that filtered the session to only include certain log streams, these streams are // listed here. LogStreamNames []string // The unique ID generated by CloudWatch Logs to identify this Live Tail session // request. RequestId *string // The unique ID generated by CloudWatch Logs to identify this Live Tail session. SessionId *string // contains filtered or unexported fields }
This object contains information about this Live Tail session, including the log groups included and the log stream filters, if any.
type LiveTailSessionUpdate ¶
type LiveTailSessionUpdate struct { // This object contains the session metadata for a Live Tail session. SessionMetadata *LiveTailSessionMetadata // An array, where each member of the array includes the information for one log // event in the Live Tail session. // // A sessionResults array can include as many as 500 log events. If the number of // log events matching the request exceeds 500 per second, the log events are // sampled down to 500 log events to be included in each sessionUpdate structure. SessionResults []LiveTailSessionLogEvent // contains filtered or unexported fields }
This object contains the log events and metadata for a Live Tail session.
type LogEvent ¶
type LogEvent struct { // The message content of the log event. Message *string // The time stamp of the log event. Timestamp *int64 // contains filtered or unexported fields }
This structure contains the information for one sample log event that is associated with an anomaly found by a log anomaly detector.
type LogGroup ¶
type LogGroup struct { // The Amazon Resource Name (ARN) of the log group. This version of the ARN // includes a trailing :* after the log group name. // // Use this version to refer to the ARN in IAM policies when specifying // permissions for most API actions. The exception is when specifying permissions // for [TagResource], [UntagResource], and [ListTagsForResource]. The permissions for those three actions require the ARN version // that doesn't include a trailing :* . // // [TagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html // [UntagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html // [ListTagsForResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html Arn *string // The creation time of the log group, expressed as the number of milliseconds // after Jan 1, 1970 00:00:00 UTC. CreationTime *int64 // Displays whether this log group has a protection policy, or whether it had one // in the past. For more information, see [PutDataProtectionPolicy]. // // [PutDataProtectionPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html DataProtectionStatus DataProtectionStatus // Displays all the properties that this log group has inherited from // account-level settings. InheritedProperties []InheritedProperty // The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. KmsKeyId *string // The Amazon Resource Name (ARN) of the log group. This version of the ARN // doesn't include a trailing :* after the log group name. // // Use this version to refer to the ARN in the following situations: // // - In the logGroupIdentifier input field in many CloudWatch Logs APIs. // // - In the resourceArn field in tagging APIs // // - In IAM policies, when specifying permissions for [TagResource], [UntagResource], and [ListTagsForResource]. // // [TagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html // [UntagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html // [ListTagsForResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html LogGroupArn *string // This specifies the log group class for this log group. There are two classes: // // - The Standard log class supports all CloudWatch Logs features. // // - The Infrequent Access log class supports a subset of CloudWatch Logs // features and incurs lower costs. // // For details about the features supported by each class, see [Log classes] // // [Log classes]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html LogGroupClass LogGroupClass // The name of the log group. LogGroupName *string // The number of metric filters. MetricFilterCount *int32 // The number of days to retain the log events in the specified log group. // Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, // 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653. // // To set a log group so that its log events do not expire, use [DeleteRetentionPolicy]. // // [DeleteRetentionPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html RetentionInDays *int32 // The number of bytes stored. StoredBytes *int64 // contains filtered or unexported fields }
Represents a log group.
type LogGroupClass ¶
type LogGroupClass string
const ( LogGroupClassStandard LogGroupClass = "STANDARD" LogGroupClassInfrequentAccess LogGroupClass = "INFREQUENT_ACCESS" )
Enum values for LogGroupClass
func (LogGroupClass) Values ¶
func (LogGroupClass) Values() []LogGroupClass
Values returns all known values for LogGroupClass. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type LogGroupField ¶
type LogGroupField struct { // The name of a log field. Name *string // The percentage of log events queried that contained the field. Percent int32 // contains filtered or unexported fields }
The fields contained in log events found by a GetLogGroupFields operation, along with the percentage of queried log events in which each field appears.
type LogStream ¶
type LogStream struct { // The Amazon Resource Name (ARN) of the log stream. Arn *string // The creation time of the stream, expressed as the number of milliseconds after // Jan 1, 1970 00:00:00 UTC . CreationTime *int64 // The time of the first event, expressed as the number of milliseconds after Jan // 1, 1970 00:00:00 UTC . FirstEventTimestamp *int64 // The time of the most recent log event in the log stream in CloudWatch Logs. // This number is expressed as the number of milliseconds after Jan 1, 1970 // 00:00:00 UTC . The lastEventTime value updates on an eventual consistency // basis. It typically updates in less than an hour from ingestion, but in rare // situations might take longer. LastEventTimestamp *int64 // The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 // 00:00:00 UTC The lastIngestionTime value updates on an eventual consistency // basis. It typically updates in less than an hour after ingestion, but in rare // situations might take longer. LastIngestionTime *int64 // The name of the log stream. LogStreamName *string // The number of bytes stored. // // Important: As of June 17, 2019, this parameter is no longer supported for log // streams, and is always reported as zero. This change applies only to log // streams. The storedBytes parameter for log groups is not affected. // // Deprecated: Starting on June 17, 2019, this parameter will be deprecated for // log streams, and will be reported as zero. This change applies only to log // streams. The storedBytes parameter for log groups is not affected. StoredBytes *int64 // The sequence token. // // The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions // are always accepted regardless of receiving an invalid sequence token. You don't // need to obtain uploadSequenceToken to use a PutLogEvents action. UploadSequenceToken *string // contains filtered or unexported fields }
Represents a log stream, which is a sequence of log events from a single emitter of logs.
type LowerCaseString ¶
type LowerCaseString struct { // The array caontaining the keys of the fields to convert to lowercase. // // This member is required. WithKeys []string // contains filtered or unexported fields }
This processor converts a string to lowercase.
For more information about this processor including examples, see lowerCaseString in the CloudWatch Logs User Guide.
type MalformedQueryException ¶
type MalformedQueryException struct { Message *string ErrorCodeOverride *string QueryCompileError *QueryCompileError // contains filtered or unexported fields }
The query string is not valid. Details about this error are displayed in a QueryCompileError object. For more information, see QueryCompileError.
For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.
func (*MalformedQueryException) Error ¶
func (e *MalformedQueryException) Error() string
func (*MalformedQueryException) ErrorCode ¶
func (e *MalformedQueryException) ErrorCode() string
func (*MalformedQueryException) ErrorFault ¶
func (e *MalformedQueryException) ErrorFault() smithy.ErrorFault
func (*MalformedQueryException) ErrorMessage ¶
func (e *MalformedQueryException) ErrorMessage() string
type MetricFilter ¶
type MetricFilter struct { // This parameter is valid only for log groups that have an active log // transformer. For more information about log transformers, see [PutTransformer]. // // If this value is true , the metric filter is applied on the transformed version // of the log events instead of the original ingested log events. // // [PutTransformer]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html ApplyOnTransformedLogs bool // The creation time of the metric filter, expressed as the number of milliseconds // after Jan 1, 1970 00:00:00 UTC . CreationTime *int64 // The name of the metric filter. FilterName *string // A symbolic description of how CloudWatch Logs should interpret the data in each // log event. For example, a log event can contain timestamps, IP addresses, // strings, and so on. You use the filter pattern to specify what to look for in // the log event message. FilterPattern *string // The name of the log group. LogGroupName *string // The metric transformations. MetricTransformations []MetricTransformation // contains filtered or unexported fields }
Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.
type MetricFilterMatchRecord ¶
type MetricFilterMatchRecord struct { // The raw event data. EventMessage *string // The event number. EventNumber int64 // The values extracted from the event data by the filter. ExtractedValues map[string]string // contains filtered or unexported fields }
Represents a matched event.
type MetricTransformation ¶
type MetricTransformation struct { // The name of the CloudWatch metric. // // This member is required. MetricName *string // A custom namespace to contain your metric in CloudWatch. Use namespaces to // group together metrics that are similar. For more information, see [Namespaces]. // // [Namespaces]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace // // This member is required. MetricNamespace *string // The value to publish to the CloudWatch metric when a filter pattern matches a // log event. // // This member is required. MetricValue *string // (Optional) The value to emit when a filter pattern does not match a log event. // This value can be null. DefaultValue *float64 // The fields to use as dimensions for the metric. One metric filter can include // as many as three dimensions. // // 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 1000 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]. // // [Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html Dimensions map[string]string // The unit to assign to the metric. If you omit this, the unit is set as None . Unit StandardUnit // contains filtered or unexported fields }
Indicates how to transform ingested log events to metric data in a CloudWatch metric.
type MoveKeyEntry ¶
type MoveKeyEntry struct { // The key to move. // // This member is required. Source *string // The key to move to. // // This member is required. Target *string // Specifies whether to overwrite the value if the destination key already exists. // If you omit this, the default is false . OverwriteIfExists bool // contains filtered or unexported fields }
This object defines one key that will be moved with the moveKey processor.
type MoveKeys ¶
type MoveKeys struct { // An array of objects, where each object contains the information about one key // to move. // // This member is required. Entries []MoveKeyEntry // contains filtered or unexported fields }
This processor moves a key from one field to another. The original key is deleted.
For more information about this processor including examples, see moveKeys in the CloudWatch Logs User Guide.
type OpenSearchApplication ¶
type OpenSearchApplication struct { // The Amazon Resource Name (ARN) of the application. ApplicationArn *string // The endpoint of the application. ApplicationEndpoint *string // The ID of the application. ApplicationId *string // This structure contains information about the status of this OpenSearch Service // resource. Status *OpenSearchResourceStatus // contains filtered or unexported fields }
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.
type OpenSearchCollection ¶
type OpenSearchCollection struct { // The ARN of the collection. CollectionArn *string // The endpoint of the collection. CollectionEndpoint *string // This structure contains information about the status of this OpenSearch Service // resource. Status *OpenSearchResourceStatus // contains filtered or unexported fields }
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.
type OpenSearchDataAccessPolicy ¶
type OpenSearchDataAccessPolicy struct { // The name of the data access policy. PolicyName *string // This structure contains information about the status of this OpenSearch Service // resource. Status *OpenSearchResourceStatus // contains filtered or unexported fields }
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 Serverlessin the OpenSearch Service Developer Guide.
type OpenSearchDataSource ¶
type OpenSearchDataSource struct { // The name of the OpenSearch Service data source. DataSourceName *string // This structure contains information about the status of this OpenSearch Service // resource. Status *OpenSearchResourceStatus // contains filtered or unexported fields }
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.
For more information about OpenSearch Service data sources , see Creating OpenSearch Service data source integrations with Amazon S3.
type OpenSearchEncryptionPolicy ¶
type OpenSearchEncryptionPolicy struct { // The name of the encryption policy. PolicyName *string // This structure contains information about the status of this OpenSearch Service // resource. Status *OpenSearchResourceStatus // contains filtered or unexported fields }
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 policiesin the OpenSearch Service Developer Guide.
type OpenSearchIntegrationDetails ¶
type OpenSearchIntegrationDetails struct { // 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. // // [Data access control for Amazon OpenSearch Serverless]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html AccessPolicy *OpenSearchDataAccessPolicy // This structure contains information about the OpenSearch Service application // used for this integration. An OpenSearch Service application is the web // application that was created by the integration with CloudWatch Logs. It hosts // the vended logs dashboards. Application *OpenSearchApplication // This structure contains information about the OpenSearch Service collection // used for this integration. This collection was created as part of the // integration setup. 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] // . // // [Creating and managing OpenSearch Service Serverless collections]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-collections.html Collection *OpenSearchCollection // 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. // // For more information about OpenSearch Service data sources , see [Creating OpenSearch Service data source integrations with Amazon S3.] // // [Creating OpenSearch Service data source integrations with Amazon S3.]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html DataSource *OpenSearchDataSource // 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. // // [Encryption policies]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html#serverless-encryption-policies EncryptionPolicy *OpenSearchEncryptionPolicy // 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. // // For more information, see [Using data lifecycle policies with OpenSearch Service Serverless] in the OpenSearch Service Developer Guide. // // [Using data lifecycle policies with OpenSearch Service Serverless]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html LifecyclePolicy *OpenSearchLifecyclePolicy // 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. // // [Network policies]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html#serverless-network-policies NetworkPolicy *OpenSearchNetworkPolicy // 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]. // // [Centralized OpenSearch user interface (Dashboards) with OpenSearch Service]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html Workspace *OpenSearchWorkspace // contains filtered or unexported fields }
This structure contains complete information about one CloudWatch Logs integration. This structure is returned by a GetIntegrationoperation.
type OpenSearchLifecyclePolicy ¶
type OpenSearchLifecyclePolicy struct { // The name of the lifecycle policy. PolicyName *string // This structure contains information about the status of this OpenSearch Service // resource. Status *OpenSearchResourceStatus // contains filtered or unexported fields }
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.
For more information, see Using data lifecycle policies with OpenSearch Service Serverless in the OpenSearch Service Developer Guide.
type OpenSearchNetworkPolicy ¶
type OpenSearchNetworkPolicy struct { // The name of the network policy. PolicyName *string // This structure contains information about the status of this OpenSearch Service // resource. Status *OpenSearchResourceStatus // contains filtered or unexported fields }
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 policiesin the OpenSearch Service Developer Guide.
type OpenSearchResourceConfig ¶
type OpenSearchResourceConfig struct { // Specify the ARNs of IAM roles and IAM users who you want to grant permission to // for viewing the dashboards. // // In addition to specifying these users here, you must also grant them the // CloudWatchOpenSearchDashboardAccess IAM policy. For more information, see [IAM policies for users]. // // [IAM policies for users]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-UserRoles.html // // This member is required. DashboardViewerPrincipals []string // Specify the ARN of an IAM role that CloudWatch Logs will use to create the // integration. This role must have the permissions necessary to access the // OpenSearch Service collection to be able to create the dashboards. For more // information about the permissions needed, see [Permissions that the integration needs]in the CloudWatch Logs User Guide. // // [Permissions that the integration needs]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-CreateRole.html // // This member is required. DataSourceRoleArn *string // Specify how many days that you want the data derived by OpenSearch Service to // be retained in the index that the dashboard refers to. This also sets the // maximum time period that you can choose when viewing data in the dashboard. // Choosing a longer time frame will incur additional costs. // // This member is required. RetentionDays *int32 // If you want to use an existing OpenSearch Service application for your // integration with OpenSearch Service, specify it here. If you omit this, a new // application will be created. ApplicationArn *string // To have the vended dashboard data encrypted with KMS instead of the CloudWatch // Logs default encryption method, specify the ARN of the KMS key that you want to // use. KmsKeyArn *string // contains filtered or unexported fields }
This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.
type OpenSearchResourceStatus ¶
type OpenSearchResourceStatus struct { // The current status of this resource. Status OpenSearchResourceStatusType // A message with additional information about the status of this resource. StatusMessage *string // contains filtered or unexported fields }
This structure contains information about the status of an OpenSearch Service resource.
type OpenSearchResourceStatusType ¶
type OpenSearchResourceStatusType string
const ( OpenSearchResourceStatusTypeActive OpenSearchResourceStatusType = "ACTIVE" OpenSearchResourceStatusTypeNotFound OpenSearchResourceStatusType = "NOT_FOUND" OpenSearchResourceStatusTypeError OpenSearchResourceStatusType = "ERROR" )
Enum values for OpenSearchResourceStatusType
func (OpenSearchResourceStatusType) Values ¶
func (OpenSearchResourceStatusType) Values() []OpenSearchResourceStatusType
Values returns all known values for OpenSearchResourceStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type OpenSearchWorkspace ¶
type OpenSearchWorkspace struct { // This structure contains information about the status of an OpenSearch Service // resource. Status *OpenSearchResourceStatus // The ID of this workspace. WorkspaceId *string // contains filtered or unexported fields }
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.
type OperationAbortedException ¶
type OperationAbortedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
Multiple concurrent requests to update the same resource were in conflict.
func (*OperationAbortedException) Error ¶
func (e *OperationAbortedException) Error() string
func (*OperationAbortedException) ErrorCode ¶
func (e *OperationAbortedException) ErrorCode() string
func (*OperationAbortedException) ErrorFault ¶
func (e *OperationAbortedException) ErrorFault() smithy.ErrorFault
func (*OperationAbortedException) ErrorMessage ¶
func (e *OperationAbortedException) ErrorMessage() string
type OrderBy ¶
type OrderBy string
const ( OrderByLogStreamName OrderBy = "LogStreamName" OrderByLastEventTime OrderBy = "LastEventTime" )
Enum values for OrderBy
func (OrderBy) Values ¶
Values returns all known values for OrderBy. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type OutputFormat ¶
type OutputFormat string
const ( OutputFormatJson OutputFormat = "json" OutputFormatPlain OutputFormat = "plain" OutputFormatW3c OutputFormat = "w3c" OutputFormatRaw OutputFormat = "raw" OutputFormatParquet OutputFormat = "parquet" )
Enum values for OutputFormat
func (OutputFormat) Values ¶
func (OutputFormat) Values() []OutputFormat
Values returns all known values for OutputFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type OutputLogEvent ¶
type OutputLogEvent struct { // The time the event was ingested, expressed as the number of milliseconds after // Jan 1, 1970 00:00:00 UTC . IngestionTime *int64 // The data contained in the log event. Message *string // The time the event occurred, expressed as the number of milliseconds after Jan // 1, 1970 00:00:00 UTC . Timestamp *int64 // contains filtered or unexported fields }
Represents a log event.
type ParseCloudfront ¶
type ParseCloudfront struct { // Omit this parameter and the whole log message will be processed by this // processor. No other value than @message is allowed for source . Source *string // contains filtered or unexported fields }
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
For more information about CloudFront log format, see Configure and use standard logs (access logs).
If you use this processor, it must be the first processor in your transformer.
type ParseJSON ¶
type ParseJSON struct { // The location to put the parsed key value pair into. If you omit this parameter, // it is placed under the root node. Destination *string // Path to the field in the log event that will be parsed. Use dot notation to // access child fields. For example, store.book Source *string // contains filtered or unexported fields }
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.
Additionally, because you must have at least one parse-type processor in a transformer, you can use ParseJSON as that processor for JSON-format logs, so that you can also apply other processors, such as mutate processors, to these logs.
For more information about this processor including examples, see parseJSON in the CloudWatch Logs User Guide.
type ParseKeyValue ¶
type ParseKeyValue struct { // The destination field to put the extracted key-value pairs into Destination *string // The field delimiter string that is used between key-value pairs in the original // log events. If you omit this, the ampersand & character is used. FieldDelimiter *string // If you want to add a prefix to all transformed keys, specify it here. KeyPrefix *string // The delimiter string to use between the key and value in each pair in the // transformed log event. // // If you omit this, the equal = character is used. KeyValueDelimiter *string // A value to insert into the value field in the result, when a key-value pair is // not successfully split. NonMatchValue *string // Specifies whether to overwrite the value if the destination key already exists. // If you omit this, the default is false . OverwriteIfExists bool // Path to the field in the log event that will be parsed. Use dot notation to // access child fields. For example, store.book Source *string // contains filtered or unexported fields }
This processor parses a specified field in the original log event into key-value pairs.
For more information about this processor including examples, see parseKeyValue in the CloudWatch Logs User Guide.
type ParsePostgres ¶
type ParsePostgres struct { // Omit this parameter and the whole log message will be processed by this // processor. No other value than @message is allowed for source . Source *string // contains filtered or unexported fields }
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.
For more information about RDS for PostgreSQL log format, see RDS for PostgreSQL database log filesTCP flag sequence.
If you use this processor, it must be the first processor in your transformer.
type ParseRoute53 ¶
type ParseRoute53 struct { // Omit this parameter and the whole log message will be processed by this // processor. No other value than @message is allowed for source . Source *string // contains filtered or unexported fields }
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.
If you use this processor, it must be the first processor in your transformer.
type ParseVPC ¶
type ParseVPC struct { // Omit this parameter and the whole log message will be processed by this // processor. No other value than @message is allowed for source . Source *string // contains filtered or unexported fields }
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.
This processor doesn't support custom log formats, such as NAT gateway logs. For more information about custom log formats in Amazon VPC, see parseVPCFor more information about this processor including examples, see parseVPC.
If you use this processor, it must be the first processor in your transformer.
type ParseWAF ¶
type ParseWAF struct { // Omit this parameter and the whole log message will be processed by this // processor. No other value than @message is allowed for source . Source *string // contains filtered or unexported fields }
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.
For more information about WAF log format, see Log examples for web ACL traffic.
If you use this processor, it must be the first processor in your transformer.
type PatternToken ¶
type PatternToken struct { // For a dynamic token, this indicates where in the pattern that this token // appears, related to other dynamic tokens. The dynamic token that appears first // has a value of 1 , the one that appears second is 2 , and so on. DynamicTokenPosition int32 // Contains the values found for a dynamic token, and the number of times each // value was found. Enumerations map[string]int64 // A name that CloudWatch Logs assigned to this dynamic token to make the pattern // more readable. The string part of the inferredTokenName gives you a clearer // idea of the content of this token. The number part of the inferredTokenName // shows where in the pattern this token appears, compared to other dynamic tokens. // CloudWatch Logs assigns the string part of the name based on analyzing the // content of the log events that contain it. // // For example, an inferred token name of IPAddress-3 means that the token // represents an IP address, and this token is the third dynamic token in the // pattern. InferredTokenName *string // Specifies whether this is a dynamic token. IsDynamic *bool // The string represented by this token. If this is a dynamic token, the value // will be <*> TokenString *string // contains filtered or unexported fields }
A structure that contains information about one pattern token related to an anomaly.
For more information about patterns and tokens, see CreateLogAnomalyDetector.
type Policy ¶
type Policy struct { // The contents of the delivery destination policy. DeliveryDestinationPolicy *string // contains filtered or unexported fields }
A structure that contains information about one delivery destination policy.
type PolicyType ¶
type PolicyType string
const ( PolicyTypeDataProtectionPolicy PolicyType = "DATA_PROTECTION_POLICY" PolicyTypeSubscriptionFilterPolicy PolicyType = "SUBSCRIPTION_FILTER_POLICY" PolicyTypeFieldIndexPolicy PolicyType = "FIELD_INDEX_POLICY" PolicyTypeTransformerPolicy PolicyType = "TRANSFORMER_POLICY" )
Enum values for PolicyType
func (PolicyType) Values ¶
func (PolicyType) Values() []PolicyType
Values returns all known values for PolicyType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Processor ¶
type Processor struct { // Use this parameter to include the [addKeys] processor in your transformer. // // [addKeys]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-addKeys AddKeys *AddKeys // Use this parameter to include the [copyValue] processor in your transformer. // // [copyValue]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-copyValue CopyValue *CopyValue // Use this parameter to include the [CSV] processor in your transformer. // // [CSV]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-CSV Csv *CSV // Use this parameter to include the [datetimeConverter] processor in your transformer. // // [datetimeConverter]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-datetimeConverter DateTimeConverter *DateTimeConverter // Use this parameter to include the [deleteKeys] processor in your transformer. // // [deleteKeys]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-deleteKeys DeleteKeys *DeleteKeys // Use this parameter to include the [grok] processor in your transformer. // // [grok]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-grok Grok *Grok // Use this parameter to include the [listToMap] processor in your transformer. // // [listToMap]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-listToMap ListToMap *ListToMap // Use this parameter to include the [lowerCaseString] processor in your transformer. // // [lowerCaseString]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-lowerCaseString LowerCaseString *LowerCaseString // Use this parameter to include the [moveKeys] processor in your transformer. // // [moveKeys]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-moveKeys MoveKeys *MoveKeys // Use this parameter to include the [parseCloudfront] processor in your transformer. // // If you use this processor, it must be the first processor in your transformer. // // [parseCloudfront]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-parseCloudfront ParseCloudfront *ParseCloudfront // Use this parameter to include the [parseJSON] processor in your transformer. // // [parseJSON]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-parseJSON ParseJSON *ParseJSON // Use this parameter to include the [parseKeyValue] processor in your transformer. // // [parseKeyValue]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-parseKeyValue ParseKeyValue *ParseKeyValue // Use this parameter to include the [parsePostGres] processor in your transformer. // // If you use this processor, it must be the first processor in your transformer. // // [parsePostGres]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-parsePostGres ParsePostgres *ParsePostgres // Use this parameter to include the [parseRoute53] processor in your transformer. // // If you use this processor, it must be the first processor in your transformer. // // [parseRoute53]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-parseRoute53 ParseRoute53 *ParseRoute53 // Use this parameter to include the [parseVPC] processor in your transformer. // // If you use this processor, it must be the first processor in your transformer. // // [parseVPC]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-parseVPC ParseVPC *ParseVPC // Use this parameter to include the [parseWAF] processor in your transformer. // // If you use this processor, it must be the first processor in your transformer. // // [parseWAF]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-parseWAF ParseWAF *ParseWAF // Use this parameter to include the [renameKeys] processor in your transformer. // // [renameKeys]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-renameKeys RenameKeys *RenameKeys // Use this parameter to include the [splitString] processor in your transformer. // // [splitString]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-splitString SplitString *SplitString // Use this parameter to include the [substituteString] processor in your transformer. // // [substituteString]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-substituteString SubstituteString *SubstituteString // Use this parameter to include the [trimString] processor in your transformer. // // [trimString]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-trimString TrimString *TrimString // Use this parameter to include the [typeConverter] processor in your transformer. // // [typeConverter]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-typeConverter TypeConverter *TypeConverter // Use this parameter to include the [upperCaseString] processor in your transformer. // // [upperCaseString]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-upperCaseString UpperCaseString *UpperCaseString // contains filtered or unexported fields }
This structure contains the information about one processor in a log transformer.
type QueryCompileError ¶
type QueryCompileError struct { // Reserved. Location *QueryCompileErrorLocation // Reserved. Message *string // contains filtered or unexported fields }
Reserved.
type QueryCompileErrorLocation ¶
type QueryCompileErrorLocation struct { // Reserved. EndCharOffset *int32 // Reserved. StartCharOffset *int32 // contains filtered or unexported fields }
Reserved.
type QueryDefinition ¶
type QueryDefinition struct { // The date that the query definition was most recently modified. LastModified *int64 // If this query definition contains a list of log groups that it is limited to, // that list appears here. LogGroupNames []string // The name of the query definition. Name *string // The unique ID of the query definition. QueryDefinitionId *string // The query language used for this query. For more information about the query // languages that CloudWatch Logs supports, see [Supported query languages]. // // [Supported query languages]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html QueryLanguage QueryLanguage // The query string to use for this definition. For more information, see [CloudWatch Logs Insights Query Syntax]. // // [CloudWatch Logs Insights Query Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html QueryString *string // contains filtered or unexported fields }
This structure contains details about a saved CloudWatch Logs Insights query definition.
type QueryInfo ¶
type QueryInfo struct { // The date and time that this query was created. CreateTime *int64 // The name of the log group scanned by this query. LogGroupName *string // The unique ID number of this query. QueryId *string // The query language used for this query. For more information about the query // languages that CloudWatch Logs supports, see [Supported query languages]. // // [Supported query languages]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html QueryLanguage QueryLanguage // The query string used in this query. QueryString *string // The status of this query. Possible values are Cancelled , Complete , Failed , // Running , Scheduled , and Unknown . Status QueryStatus // contains filtered or unexported fields }
Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.
type QueryLanguage ¶
type QueryLanguage string
const ( QueryLanguageCwli QueryLanguage = "CWLI" QueryLanguageSql QueryLanguage = "SQL" QueryLanguagePpl QueryLanguage = "PPL" )
Enum values for QueryLanguage
func (QueryLanguage) Values ¶
func (QueryLanguage) Values() []QueryLanguage
Values returns all known values for QueryLanguage. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type QueryStatistics ¶
type QueryStatistics struct { // The total number of bytes in the log events scanned during the query. BytesScanned float64 // An estimate of the number of bytes in the log events that were skipped when // processing this query, because the query contained an indexed field. Skipping // these entries lowers query costs and improves the query performance time. For // more information about field indexes, see [PutIndexPolicy]. // // [PutIndexPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html EstimatedBytesSkipped float64 // An estimate of the number of log events that were skipped when processing this // query, because the query contained an indexed field. Skipping these entries // lowers query costs and improves the query performance time. For more information // about field indexes, see [PutIndexPolicy]. // // [PutIndexPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html EstimatedRecordsSkipped float64 // The number of log groups that were scanned by this query. LogGroupsScanned float64 // The number of log events that matched the query string. RecordsMatched float64 // The total number of log events scanned during the query. RecordsScanned float64 // contains filtered or unexported fields }
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.
If the query involved log groups that have field index policies, the estimated number of skipped log events and the total bytes of those skipped log events are included. Using field indexes to skip log events in queries reduces scan volume and improves performance. For more information, see Create field indexes to improve query performance and reduce scan volume.
type QueryStatus ¶
type QueryStatus string
const ( QueryStatusScheduled QueryStatus = "Scheduled" QueryStatusRunning QueryStatus = "Running" QueryStatusComplete QueryStatus = "Complete" QueryStatusFailed QueryStatus = "Failed" QueryStatusCancelled QueryStatus = "Cancelled" QueryStatusTimeout QueryStatus = "Timeout" QueryStatusUnknown QueryStatus = "Unknown" )
Enum values for QueryStatus
func (QueryStatus) Values ¶
func (QueryStatus) Values() []QueryStatus
Values returns all known values for QueryStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type RecordField ¶
type RecordField struct { // If this is true , the record field must be present in the recordFields // parameter provided to a [CreateDelivery]or [UpdateDeliveryConfiguration] operation. // // [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html // [UpdateDeliveryConfiguration]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html Mandatory *bool // The name to use when specifying this record field in a [CreateDelivery] or [UpdateDeliveryConfiguration] operation. // // [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html // [UpdateDeliveryConfiguration]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html Name *string // contains filtered or unexported fields }
A structure that represents a valid record field header and whether it is mandatory.
type RejectedEntityInfo ¶
type RejectedEntityInfo struct { // The type of error that caused the rejection of the entity when calling // PutLogEvents . // // This member is required. ErrorType EntityRejectionErrorType // contains filtered or unexported fields }
If an entity is rejected when a PutLogEvents request was made, this includes details about the reason for the rejection.
type RejectedLogEventsInfo ¶
type RejectedLogEventsInfo struct { // The expired log events. ExpiredLogEventEndIndex *int32 // The index of the first log event that is too new. This field is inclusive. TooNewLogEventStartIndex *int32 // The index of the last log event that is too old. This field is exclusive. TooOldLogEventEndIndex *int32 // contains filtered or unexported fields }
Represents the rejected events.
type RenameKeyEntry ¶
type RenameKeyEntry struct { // The key to rename // // This member is required. Key *string // The string to use for the new key name // // This member is required. RenameTo *string // Specifies whether to overwrite the existing value if the destination key // already exists. The default is false OverwriteIfExists bool // contains filtered or unexported fields }
This object defines one key that will be renamed with the renameKey processor.
type RenameKeys ¶
type RenameKeys struct { // An array of RenameKeyEntry objects, where each object contains the information // about a single key to rename. // // This member is required. Entries []RenameKeyEntry // contains filtered or unexported fields }
Use this processor to rename keys in a log event.
For more information about this processor including examples, see renameKeys in the CloudWatch Logs User Guide.
type ResourceAlreadyExistsException ¶
type ResourceAlreadyExistsException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The specified resource already exists.
func (*ResourceAlreadyExistsException) Error ¶
func (e *ResourceAlreadyExistsException) Error() string
func (*ResourceAlreadyExistsException) ErrorCode ¶
func (e *ResourceAlreadyExistsException) ErrorCode() string
func (*ResourceAlreadyExistsException) ErrorFault ¶
func (e *ResourceAlreadyExistsException) ErrorFault() smithy.ErrorFault
func (*ResourceAlreadyExistsException) ErrorMessage ¶
func (e *ResourceAlreadyExistsException) ErrorMessage() string
type ResourceConfig ¶
type ResourceConfig interface {
// contains filtered or unexported methods
}
This structure contains configuration details about an integration between CloudWatch Logs and another entity.
The following types satisfy this interface:
ResourceConfigMemberOpenSearchResourceConfig
Example (OutputUsage)¶
Code:play
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs/types" ) func main() { var union types.ResourceConfig // type switches can be used to check the union value switch v := union.(type) { case *types.ResourceConfigMemberOpenSearchResourceConfig: _ = v.Value // Value is types.OpenSearchResourceConfig case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
type ResourceConfigMemberOpenSearchResourceConfig ¶
type ResourceConfigMemberOpenSearchResourceConfig struct { Value OpenSearchResourceConfig // contains filtered or unexported fields }
This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The specified resource does not exist.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type ResourcePolicy ¶
type ResourcePolicy struct { // Timestamp showing when this policy was last updated, expressed as the number of // milliseconds after Jan 1, 1970 00:00:00 UTC . LastUpdatedTime *int64 // The details of the policy. PolicyDocument *string // The name of the resource policy. PolicyName *string // contains filtered or unexported fields }
A policy enabling one or more entities to put logs to a log group in this account.
type ResultField ¶
type ResultField struct { // The log event field. Field *string // The value of this field. Value *string // contains filtered or unexported fields }
Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.
For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.
type S3DeliveryConfiguration ¶
type S3DeliveryConfiguration struct { // This parameter causes the S3 objects that contain delivered logs to use a // prefix structure that allows for integration with Apache Hive. EnableHiveCompatiblePath *bool // This string allows re-configuring the S3 object prefix to contain either static // or variable sections. The valid variables to use in the suffix path will vary by // each log source. To find the values supported for the suffix path for each log // source, use the [DescribeConfigurationTemplates]operation and check the allowedSuffixPathFields field in the // response. // // [DescribeConfigurationTemplates]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeConfigurationTemplates.html SuffixPath *string // contains filtered or unexported fields }
This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.
type Scope ¶
type Scope string
const ( ScopeAll Scope = "ALL" )
Enum values for Scope
func (Scope) Values ¶
Values returns all known values for Scope. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SearchedLogStream ¶
type SearchedLogStream struct { // The name of the log stream. LogStreamName *string // Indicates whether all the events in this log stream were searched. SearchedCompletely *bool // contains filtered or unexported fields }
Represents the search status of a log stream.
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
This request exceeds a service quota.
func (*ServiceQuotaExceededException) Error ¶
func (e *ServiceQuotaExceededException) Error() string
func (*ServiceQuotaExceededException) ErrorCode ¶
func (e *ServiceQuotaExceededException) ErrorCode() string
func (*ServiceQuotaExceededException) ErrorFault ¶
func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
func (*ServiceQuotaExceededException) ErrorMessage ¶
func (e *ServiceQuotaExceededException) ErrorMessage() string
type ServiceUnavailableException ¶
type ServiceUnavailableException struct { string *string // contains filtered or unexported fields }*
The service cannot complete the request.
func (*ServiceUnavailableException) Error ¶
func (e *ServiceUnavailableException) Error() string
func (*ServiceUnavailableException) ErrorCode ¶
func (e *ServiceUnavailableException) ErrorCode() string
func (*ServiceUnavailableException) ErrorFault ¶
func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault
func (*ServiceUnavailableException) ErrorMessage ¶
func (e *ServiceUnavailableException) ErrorMessage() string
type SessionStreamingException ¶
type SessionStreamingException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
This exception is returned if an unknown error occurs during a Live Tail session.
func (*SessionStreamingException) Error ¶
func (e *SessionStreamingException) Error() string
func (*SessionStreamingException) ErrorCode ¶
func (e *SessionStreamingException) ErrorCode() string
func (*SessionStreamingException) ErrorFault ¶
func (e *SessionStreamingException) ErrorFault() smithy.ErrorFault
func (*SessionStreamingException) ErrorMessage ¶
func (e *SessionStreamingException) ErrorMessage() string
type SessionTimeoutException ¶
type SessionTimeoutException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
This exception is returned in a Live Tail stream when the Live Tail session times out. Live Tail sessions time out after three hours.
func (*SessionTimeoutException) Error ¶
func (e *SessionTimeoutException) Error() string
func (*SessionTimeoutException) ErrorCode ¶
func (e *SessionTimeoutException) ErrorCode() string
func (*SessionTimeoutException) ErrorFault ¶
func (e *SessionTimeoutException) ErrorFault() smithy.ErrorFault
func (*SessionTimeoutException) ErrorMessage ¶
func (e *SessionTimeoutException) ErrorMessage() string
type SplitString ¶
type SplitString struct { // An array of SplitStringEntry objects, where each object contains the // information about one field to split. // // This member is required. Entries []SplitStringEntry // contains filtered or unexported fields }
Use this processor to split a field into an array of strings using a delimiting character.
For more information about this processor including examples, see splitString in the CloudWatch Logs User Guide.
type SplitStringEntry ¶
type SplitStringEntry struct { // The separator characters to split the string entry on. // // This member is required. Delimiter *string // The key of the field to split. // // This member is required. Source *string // contains filtered or unexported fields }
This object defines one log field that will be split with the splitString processor.
type StandardUnit ¶
type StandardUnit string
const ( StandardUnitSeconds StandardUnit = "Seconds" StandardUnitMicroseconds StandardUnit = "Microseconds" StandardUnitMilliseconds StandardUnit = "Milliseconds" StandardUnitBytes StandardUnit = "Bytes" StandardUnitKilobytes StandardUnit = "Kilobytes" StandardUnitMegabytes StandardUnit = "Megabytes" StandardUnitGigabytes StandardUnit = "Gigabytes" StandardUnitTerabytes StandardUnit = "Terabytes" StandardUnitBits StandardUnit = "Bits" StandardUnitKilobits StandardUnit = "Kilobits" StandardUnitMegabits StandardUnit = "Megabits" StandardUnitGigabits StandardUnit = "Gigabits" StandardUnitTerabits StandardUnit = "Terabits" StandardUnitPercent StandardUnit = "Percent" StandardUnitCount StandardUnit = "Count" StandardUnitBytesSecond StandardUnit = "Bytes/Second" StandardUnitKilobytesSecond StandardUnit = "Kilobytes/Second" StandardUnitMegabytesSecond StandardUnit = "Megabytes/Second" StandardUnitGigabytesSecond StandardUnit = "Gigabytes/Second" StandardUnitTerabytesSecond StandardUnit = "Terabytes/Second" StandardUnitBitsSecond StandardUnit = "Bits/Second" StandardUnitKilobitsSecond StandardUnit = "Kilobits/Second" StandardUnitMegabitsSecond StandardUnit = "Megabits/Second" StandardUnitGigabitsSecond StandardUnit = "Gigabits/Second" StandardUnitTerabitsSecond StandardUnit = "Terabits/Second" StandardUnitCountSecond StandardUnit = "Count/Second" StandardUnitNone StandardUnit = "None" )
Enum values for StandardUnit
func (StandardUnit) Values ¶
func (StandardUnit) Values() []StandardUnit
Values returns all known values for StandardUnit. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type StartLiveTailResponseStream ¶
type StartLiveTailResponseStream interface {
// contains filtered or unexported methods
}
This object includes the stream returned by your StartLiveTail request.
The following types satisfy this interface:
StartLiveTailResponseStreamMemberSessionStart StartLiveTailResponseStreamMemberSessionUpdate
Example (OutputUsage)¶
Code:play
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs/types" ) func main() { var union types.StartLiveTailResponseStream // type switches can be used to check the union value switch v := union.(type) { case *types.StartLiveTailResponseStreamMemberSessionStart: _ = v.Value // Value is types.LiveTailSessionStart case *types.StartLiveTailResponseStreamMemberSessionUpdate: _ = v.Value // Value is types.LiveTailSessionUpdate case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
type StartLiveTailResponseStreamMemberSessionStart ¶
type StartLiveTailResponseStreamMemberSessionStart struct { Value LiveTailSessionStart // contains filtered or unexported fields }
This object contains information about this Live Tail session, including the log groups included and the log stream filters, if any.
type StartLiveTailResponseStreamMemberSessionUpdate ¶
type StartLiveTailResponseStreamMemberSessionUpdate struct { Value LiveTailSessionUpdate // contains filtered or unexported fields }
This object contains the log events and session metadata.
type State ¶
type State string
const ( StateActive State = "Active" StateSuppressed State = "Suppressed" StateBaseline State = "Baseline" )
Enum values for State
func (State) Values ¶
Values returns all known values for State. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SubscriptionFilter ¶
type SubscriptionFilter struct { // This parameter is valid only for log groups that have an active log // transformer. For more information about log transformers, see [PutTransformer]. // // If this value is true , the subscription filter is applied on the transformed // version of the log events instead of the original ingested log events. // // [PutTransformer]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html ApplyOnTransformedLogs bool // The creation time of the subscription filter, expressed as the number of // milliseconds after Jan 1, 1970 00:00:00 UTC . CreationTime *int64 // The Amazon Resource Name (ARN) of the destination. DestinationArn *string // The method used to distribute log data to the destination, which can be either // random or grouped by log stream. Distribution Distribution // The name of the subscription filter. FilterName *string // A symbolic description of how CloudWatch Logs should interpret the data in each // log event. For example, a log event can contain timestamps, IP addresses, // strings, and so on. You use the filter pattern to specify what to look for in // the log event message. FilterPattern *string // The name of the log group. LogGroupName *string // RoleArn *string // contains filtered or unexported fields }
Represents a subscription filter.
type SubstituteString ¶
type SubstituteString struct { // An array of objects, where each object contains the information about one key // to match and replace. // // This member is required. Entries []SubstituteStringEntry // contains filtered or unexported fields }
This processor matches a key’s value against a regular expression and replaces all matches with a replacement string.
For more information about this processor including examples, see substituteString in the CloudWatch Logs User Guide.
type SubstituteStringEntry ¶
type SubstituteStringEntry struct { // The regular expression string to be replaced. Special regex characters such as // [ and ] must be escaped using \\ when using double quotes and with \ when using // single quotes. For more information, see [Class Pattern]on the Oracle web site. // // [Class Pattern]: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html // // This member is required. From *string // The key to modify // // This member is required. Source *string // The string to be substituted for each match of from // // This member is required. To *string // contains filtered or unexported fields }
This object defines one log field key that will be replaced using the substituteString processor.
type SuppressionPeriod ¶
type SuppressionPeriod struct { // Specifies whether the value of value is in seconds, minutes, or hours. SuppressionUnit SuppressionUnit // Specifies the number of seconds, minutes or hours to suppress this anomaly. // There is no maximum. Value int32 // contains filtered or unexported fields }
If you are suppressing an anomaly temporariliy, this structure defines how long the suppression period is to be.
type SuppressionState ¶
type SuppressionState string
const ( SuppressionStateSuppressed SuppressionState = "SUPPRESSED" SuppressionStateUnsuppressed SuppressionState = "UNSUPPRESSED" )
Enum values for SuppressionState
func (SuppressionState) Values ¶
func (SuppressionState) Values() []SuppressionState
Values returns all known values for SuppressionState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SuppressionType ¶
type SuppressionType string
const ( SuppressionTypeLimited SuppressionType = "LIMITED" SuppressionTypeInfinite SuppressionType = "INFINITE" )
Enum values for SuppressionType
func (SuppressionType) Values ¶
func (SuppressionType) Values() []SuppressionType
Values returns all known values for SuppressionType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SuppressionUnit ¶
type SuppressionUnit string
const ( SuppressionUnitSeconds SuppressionUnit = "SECONDS" SuppressionUnitMinutes SuppressionUnit = "MINUTES" SuppressionUnitHours SuppressionUnit = "HOURS" )
Enum values for SuppressionUnit
func (SuppressionUnit) Values ¶
func (SuppressionUnit) Values() []SuppressionUnit
Values returns all known values for SuppressionUnit. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request was throttled because of quota limits.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type TooManyTagsException ¶
type TooManyTagsException struct { Message *string ErrorCodeOverride *string ResourceName *string // contains filtered or unexported fields }
A resource can have no more than 50 tags.
func (*TooManyTagsException) Error ¶
func (e *TooManyTagsException) Error() string
func (*TooManyTagsException) ErrorCode ¶
func (e *TooManyTagsException) ErrorCode() string
func (*TooManyTagsException) ErrorFault ¶
func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault
func (*TooManyTagsException) ErrorMessage ¶
func (e *TooManyTagsException) ErrorMessage() string
type TransformedLogRecord ¶
type TransformedLogRecord struct { // The original log event message before it was transformed. EventMessage *string // The event number. EventNumber int64 // The log event message after being transformed. TransformedEventMessage *string // contains filtered or unexported fields }
This structure contains information for one log event that has been processed by a log transformer.
type TrimString ¶
type TrimString struct { // The array containing the keys of the fields to trim. // // This member is required. WithKeys []string // contains filtered or unexported fields }
Use this processor to remove leading and trailing whitespace.
For more information about this processor including examples, see trimString in the CloudWatch Logs User Guide.
type Type ¶
type Type string
const ( TypeBoolean Type = "boolean" TypeInteger Type = "integer" TypeDouble Type = "double" TypeString Type = "string" )
Enum values for Type
func (Type) Values ¶
Values returns all known values for Type. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type TypeConverter ¶
type TypeConverter struct { // An array of TypeConverterEntry objects, where each object contains the // information about one field to change the type of. // // This member is required. Entries []TypeConverterEntry // contains filtered or unexported fields }
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 .
For more information about this processor including examples, see trimString in the CloudWatch Logs User Guide.
type TypeConverterEntry ¶
type TypeConverterEntry struct { // The key with the value that is to be converted to a different type. // // This member is required. Key *string // The type to convert the field value to. Valid values are integer , double , // string and boolean . // // This member is required. Type Type // contains filtered or unexported fields }
This object defines one value type that will be converted using the typeConverter processor.
type UnknownUnionMember ¶
type UnknownUnionMember struct { Tag string Value []byte // contains filtered or unexported fields }
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
type UnrecognizedClientException ¶
type UnrecognizedClientException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The most likely cause is an Amazon Web Services access key ID or secret key that's not valid.
func (*UnrecognizedClientException) Error ¶
func (e *UnrecognizedClientException) Error() string
func (*UnrecognizedClientException) ErrorCode ¶
func (e *UnrecognizedClientException) ErrorCode() string
func (*UnrecognizedClientException) ErrorFault ¶
func (e *UnrecognizedClientException) ErrorFault() smithy.ErrorFault
func (*UnrecognizedClientException) ErrorMessage ¶
func (e *UnrecognizedClientException) ErrorMessage() string
type UpperCaseString ¶
type UpperCaseString struct { // The array of containing the keys of the field to convert to uppercase. // // This member is required. WithKeys []string // contains filtered or unexported fields }
This processor converts a string field to uppercase.
For more information about this processor including examples, see upperCaseString in the CloudWatch Logs User Guide.
type ValidationException ¶
type ValidationException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
One of the parameters for the request is not valid.
func (*ValidationException) Error ¶
func (e *ValidationException) Error() string
func (*ValidationException) ErrorCode ¶
func (e *ValidationException) ErrorCode() string
func (*ValidationException) ErrorFault ¶
func (e *ValidationException) ErrorFault() smithy.ErrorFault
func (*ValidationException) ErrorMessage ¶
func (e *ValidationException) ErrorMessage() string
Source Files ¶
- Version
- v1.47.3 (latest)
- Published
- Apr 10, 2025
- Platform
- linux/amd64
- Imports
- 3 packages
- Last checked
- 11 hours ago –
Tools for package owners.