cloudwatchlogs

package
v1.51.25 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2024 License: Apache-2.0 Imports: 17 Imported by: 1,132

Documentation

Overview

Package cloudwatchlogs provides the client and types for making API requests to Amazon CloudWatch Logs.

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.

You can use CloudWatch Logs to:

  • Monitor logs from EC2 instances in real time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs. Then, it can send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring so no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException"). You can also count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.

  • Monitor CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.

  • Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events earlier than this setting are automatically deleted. The CloudWatch Logs agent helps to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

See https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28 for more information on this service.

See cloudwatchlogs package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatchlogs/

Using the Client

To contact Amazon CloudWatch Logs with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon CloudWatch Logs client CloudWatchLogs for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatchlogs/#New

Index

Constants

View Source
const (
	// AnomalyDetectorStatusInitializing is a AnomalyDetectorStatus enum value
	AnomalyDetectorStatusInitializing = "INITIALIZING"

	// AnomalyDetectorStatusTraining is a AnomalyDetectorStatus enum value
	AnomalyDetectorStatusTraining = "TRAINING"

	// AnomalyDetectorStatusAnalyzing is a AnomalyDetectorStatus enum value
	AnomalyDetectorStatusAnalyzing = "ANALYZING"

	// AnomalyDetectorStatusFailed is a AnomalyDetectorStatus enum value
	AnomalyDetectorStatusFailed = "FAILED"

	// AnomalyDetectorStatusDeleted is a AnomalyDetectorStatus enum value
	AnomalyDetectorStatusDeleted = "DELETED"

	// AnomalyDetectorStatusPaused is a AnomalyDetectorStatus enum value
	AnomalyDetectorStatusPaused = "PAUSED"
)
View Source
const (
	// DataProtectionStatusActivated is a DataProtectionStatus enum value
	DataProtectionStatusActivated = "ACTIVATED"

	// DataProtectionStatusDeleted is a DataProtectionStatus enum value
	DataProtectionStatusDeleted = "DELETED"

	// DataProtectionStatusArchived is a DataProtectionStatus enum value
	DataProtectionStatusArchived = "ARCHIVED"

	// DataProtectionStatusDisabled is a DataProtectionStatus enum value
	DataProtectionStatusDisabled = "DISABLED"
)
View Source
const (
	// DeliveryDestinationTypeS3 is a DeliveryDestinationType enum value
	DeliveryDestinationTypeS3 = "S3"

	// DeliveryDestinationTypeCwl is a DeliveryDestinationType enum value
	DeliveryDestinationTypeCwl = "CWL"

	// DeliveryDestinationTypeFh is a DeliveryDestinationType enum value
	DeliveryDestinationTypeFh = "FH"
)
View Source
const (
	// DistributionRandom is a Distribution enum value
	DistributionRandom = "Random"

	// DistributionByLogStream is a Distribution enum value
	DistributionByLogStream = "ByLogStream"
)

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

View Source
const (
	// EvaluationFrequencyOneMin is a EvaluationFrequency enum value
	EvaluationFrequencyOneMin = "ONE_MIN"

	// EvaluationFrequencyFiveMin is a EvaluationFrequency enum value
	EvaluationFrequencyFiveMin = "FIVE_MIN"

	// EvaluationFrequencyTenMin is a EvaluationFrequency enum value
	EvaluationFrequencyTenMin = "TEN_MIN"

	// EvaluationFrequencyFifteenMin is a EvaluationFrequency enum value
	EvaluationFrequencyFifteenMin = "FIFTEEN_MIN"

	// EvaluationFrequencyThirtyMin is a EvaluationFrequency enum value
	EvaluationFrequencyThirtyMin = "THIRTY_MIN"

	// EvaluationFrequencyOneHour is a EvaluationFrequency enum value
	EvaluationFrequencyOneHour = "ONE_HOUR"
)
View Source
const (
	// ExportTaskStatusCodeCancelled is a ExportTaskStatusCode enum value
	ExportTaskStatusCodeCancelled = "CANCELLED"

	// ExportTaskStatusCodeCompleted is a ExportTaskStatusCode enum value
	ExportTaskStatusCodeCompleted = "COMPLETED"

	// ExportTaskStatusCodeFailed is a ExportTaskStatusCode enum value
	ExportTaskStatusCodeFailed = "FAILED"

	// ExportTaskStatusCodePending is a ExportTaskStatusCode enum value
	ExportTaskStatusCodePending = "PENDING"

	// ExportTaskStatusCodePendingCancel is a ExportTaskStatusCode enum value
	ExportTaskStatusCodePendingCancel = "PENDING_CANCEL"

	// ExportTaskStatusCodeRunning is a ExportTaskStatusCode enum value
	ExportTaskStatusCodeRunning = "RUNNING"
)
View Source
const (
	// LogGroupClassStandard is a LogGroupClass enum value
	LogGroupClassStandard = "STANDARD"

	// LogGroupClassInfrequentAccess is a LogGroupClass enum value
	LogGroupClassInfrequentAccess = "INFREQUENT_ACCESS"
)
View Source
const (
	// OrderByLogStreamName is a OrderBy enum value
	OrderByLogStreamName = "LogStreamName"

	// OrderByLastEventTime is a OrderBy enum value
	OrderByLastEventTime = "LastEventTime"
)
View Source
const (
	// OutputFormatJson is a OutputFormat enum value
	OutputFormatJson = "json"

	// OutputFormatPlain is a OutputFormat enum value
	OutputFormatPlain = "plain"

	// OutputFormatW3c is a OutputFormat enum value
	OutputFormatW3c = "w3c"

	// OutputFormatRaw is a OutputFormat enum value
	OutputFormatRaw = "raw"

	// OutputFormatParquet is a OutputFormat enum value
	OutputFormatParquet = "parquet"
)
View Source
const (
	// PolicyTypeDataProtectionPolicy is a PolicyType enum value
	PolicyTypeDataProtectionPolicy = "DATA_PROTECTION_POLICY"

	// PolicyTypeSubscriptionFilterPolicy is a PolicyType enum value
	PolicyTypeSubscriptionFilterPolicy = "SUBSCRIPTION_FILTER_POLICY"
)
View Source
const (
	// QueryStatusScheduled is a QueryStatus enum value
	QueryStatusScheduled = "Scheduled"

	// QueryStatusRunning is a QueryStatus enum value
	QueryStatusRunning = "Running"

	// QueryStatusComplete is a QueryStatus enum value
	QueryStatusComplete = "Complete"

	// QueryStatusFailed is a QueryStatus enum value
	QueryStatusFailed = "Failed"

	// QueryStatusCancelled is a QueryStatus enum value
	QueryStatusCancelled = "Cancelled"

	// QueryStatusTimeout is a QueryStatus enum value
	QueryStatusTimeout = "Timeout"

	// QueryStatusUnknown is a QueryStatus enum value
	QueryStatusUnknown = "Unknown"
)
View Source
const (
	// StandardUnitSeconds is a StandardUnit enum value
	StandardUnitSeconds = "Seconds"

	// StandardUnitMicroseconds is a StandardUnit enum value
	StandardUnitMicroseconds = "Microseconds"

	// StandardUnitMilliseconds is a StandardUnit enum value
	StandardUnitMilliseconds = "Milliseconds"

	// StandardUnitBytes is a StandardUnit enum value
	StandardUnitBytes = "Bytes"

	// StandardUnitKilobytes is a StandardUnit enum value
	StandardUnitKilobytes = "Kilobytes"

	// StandardUnitMegabytes is a StandardUnit enum value
	StandardUnitMegabytes = "Megabytes"

	// StandardUnitGigabytes is a StandardUnit enum value
	StandardUnitGigabytes = "Gigabytes"

	// StandardUnitTerabytes is a StandardUnit enum value
	StandardUnitTerabytes = "Terabytes"

	// StandardUnitBits is a StandardUnit enum value
	StandardUnitBits = "Bits"

	// StandardUnitKilobits is a StandardUnit enum value
	StandardUnitKilobits = "Kilobits"

	// StandardUnitMegabits is a StandardUnit enum value
	StandardUnitMegabits = "Megabits"

	// StandardUnitGigabits is a StandardUnit enum value
	StandardUnitGigabits = "Gigabits"

	// StandardUnitTerabits is a StandardUnit enum value
	StandardUnitTerabits = "Terabits"

	// StandardUnitPercent is a StandardUnit enum value
	StandardUnitPercent = "Percent"

	// StandardUnitCount is a StandardUnit enum value
	StandardUnitCount = "Count"

	// StandardUnitBytesSecond is a StandardUnit enum value
	StandardUnitBytesSecond = "Bytes/Second"

	// StandardUnitKilobytesSecond is a StandardUnit enum value
	StandardUnitKilobytesSecond = "Kilobytes/Second"

	// StandardUnitMegabytesSecond is a StandardUnit enum value
	StandardUnitMegabytesSecond = "Megabytes/Second"

	// StandardUnitGigabytesSecond is a StandardUnit enum value
	StandardUnitGigabytesSecond = "Gigabytes/Second"

	// StandardUnitTerabytesSecond is a StandardUnit enum value
	StandardUnitTerabytesSecond = "Terabytes/Second"

	// StandardUnitBitsSecond is a StandardUnit enum value
	StandardUnitBitsSecond = "Bits/Second"

	// StandardUnitKilobitsSecond is a StandardUnit enum value
	StandardUnitKilobitsSecond = "Kilobits/Second"

	// StandardUnitMegabitsSecond is a StandardUnit enum value
	StandardUnitMegabitsSecond = "Megabits/Second"

	// StandardUnitGigabitsSecond is a StandardUnit enum value
	StandardUnitGigabitsSecond = "Gigabits/Second"

	// StandardUnitTerabitsSecond is a StandardUnit enum value
	StandardUnitTerabitsSecond = "Terabits/Second"

	// StandardUnitCountSecond is a StandardUnit enum value
	StandardUnitCountSecond = "Count/Second"

	// StandardUnitNone is a StandardUnit enum value
	StandardUnitNone = "None"
)
View Source
const (
	// StateActive is a State enum value
	StateActive = "Active"

	// StateSuppressed is a State enum value
	StateSuppressed = "Suppressed"

	// StateBaseline is a State enum value
	StateBaseline = "Baseline"
)
View Source
const (
	// SuppressionStateSuppressed is a SuppressionState enum value
	SuppressionStateSuppressed = "SUPPRESSED"

	// SuppressionStateUnsuppressed is a SuppressionState enum value
	SuppressionStateUnsuppressed = "UNSUPPRESSED"
)
View Source
const (
	// SuppressionTypeLimited is a SuppressionType enum value
	SuppressionTypeLimited = "LIMITED"

	// SuppressionTypeInfinite is a SuppressionType enum value
	SuppressionTypeInfinite = "INFINITE"
)
View Source
const (
	// SuppressionUnitSeconds is a SuppressionUnit enum value
	SuppressionUnitSeconds = "SECONDS"

	// SuppressionUnitMinutes is a SuppressionUnit enum value
	SuppressionUnitMinutes = "MINUTES"

	// SuppressionUnitHours is a SuppressionUnit enum value
	SuppressionUnitHours = "HOURS"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You don't have sufficient permissions to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// This operation attempted to create a resource that already exists.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeDataAlreadyAcceptedException for service response error code
	// "DataAlreadyAcceptedException".
	//
	// 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.
	ErrCodeDataAlreadyAcceptedException = "DataAlreadyAcceptedException"

	// ErrCodeInvalidOperationException for service response error code
	// "InvalidOperationException".
	//
	// The operation is not valid on the specified resource.
	ErrCodeInvalidOperationException = "InvalidOperationException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// A parameter is specified incorrectly.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidSequenceTokenException for service response error code
	// "InvalidSequenceTokenException".
	//
	// 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.
	ErrCodeInvalidSequenceTokenException = "InvalidSequenceTokenException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// You have reached the maximum number of resources that can be created.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeMalformedQueryException for service response error code
	// "MalformedQueryException".
	//
	// The query string is not valid. Details about this error are displayed in
	// a QueryCompileError object. For more information, see QueryCompileError (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_QueryCompileError.html).
	//
	// For more information about valid query syntax, see CloudWatch Logs Insights
	// Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).
	ErrCodeMalformedQueryException = "MalformedQueryException"

	// ErrCodeOperationAbortedException for service response error code
	// "OperationAbortedException".
	//
	// Multiple concurrent requests to update the same resource were in conflict.
	ErrCodeOperationAbortedException = "OperationAbortedException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The specified resource already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// This request exceeds a service quota.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service cannot complete the request.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeSessionStreamingException for service response error code
	// "SessionStreamingException".
	//
	// his exception is returned if an unknown error occurs during a Live Tail session.
	ErrCodeSessionStreamingException = "SessionStreamingException"

	// ErrCodeSessionTimeoutException for service response error code
	// "SessionTimeoutException".
	//
	// This exception is returned in a Live Tail stream when the Live Tail session
	// times out. Live Tail sessions time out after three hours.
	ErrCodeSessionTimeoutException = "SessionTimeoutException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was throttled because of quota limits.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// A resource can have no more than 50 tags.
	ErrCodeTooManyTagsException = "TooManyTagsException"

	// ErrCodeUnrecognizedClientException for service response error code
	// "UnrecognizedClientException".
	//
	// The most likely cause is an Amazon Web Services access key ID or secret key
	// that's not valid.
	ErrCodeUnrecognizedClientException = "UnrecognizedClientException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// One of the parameters for the request is not valid.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "logs"            // Name of service.
	EndpointsID = ServiceName       // ID to lookup a service endpoint with.
	ServiceID   = "CloudWatch Logs" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// InheritedPropertyAccountDataProtection is a InheritedProperty enum value
	InheritedPropertyAccountDataProtection = "ACCOUNT_DATA_PROTECTION"
)
View Source
const (
	// ScopeAll is a Scope enum value
	ScopeAll = "ALL"
)

Variables

This section is empty.

Functions

func AnomalyDetectorStatus_Values added in v1.48.4

func AnomalyDetectorStatus_Values() []string

AnomalyDetectorStatus_Values returns all elements of the AnomalyDetectorStatus enum

func DataProtectionStatus_Values added in v1.44.146

func DataProtectionStatus_Values() []string

DataProtectionStatus_Values returns all elements of the DataProtectionStatus enum

func DeliveryDestinationType_Values added in v1.47.8

func DeliveryDestinationType_Values() []string

DeliveryDestinationType_Values returns all elements of the DeliveryDestinationType enum

func Distribution_Values added in v1.34.3

func Distribution_Values() []string

Distribution_Values returns all elements of the Distribution enum

func EvaluationFrequency_Values added in v1.48.4

func EvaluationFrequency_Values() []string

EvaluationFrequency_Values returns all elements of the EvaluationFrequency enum

func ExportTaskStatusCode_Values added in v1.34.3

func ExportTaskStatusCode_Values() []string

ExportTaskStatusCode_Values returns all elements of the ExportTaskStatusCode enum

func InheritedProperty_Values added in v1.44.278

func InheritedProperty_Values() []string

InheritedProperty_Values returns all elements of the InheritedProperty enum

func LogGroupClass_Values added in v1.48.4

func LogGroupClass_Values() []string

LogGroupClass_Values returns all elements of the LogGroupClass enum

func OrderBy_Values added in v1.34.3

func OrderBy_Values() []string

OrderBy_Values returns all elements of the OrderBy enum

func OutputFormat_Values added in v1.47.8

func OutputFormat_Values() []string

OutputFormat_Values returns all elements of the OutputFormat enum

func PolicyType_Values added in v1.44.278

func PolicyType_Values() []string

PolicyType_Values returns all elements of the PolicyType enum

func QueryStatus_Values added in v1.34.3

func QueryStatus_Values() []string

QueryStatus_Values returns all elements of the QueryStatus enum

func Scope_Values added in v1.44.278

func Scope_Values() []string

Scope_Values returns all elements of the Scope enum

func StandardUnit_Values added in v1.38.46

func StandardUnit_Values() []string

StandardUnit_Values returns all elements of the StandardUnit enum

func State_Values added in v1.48.4

func State_Values() []string

State_Values returns all elements of the State enum

func SuppressionState_Values added in v1.48.4

func SuppressionState_Values() []string

SuppressionState_Values returns all elements of the SuppressionState enum

func SuppressionType_Values added in v1.48.4

func SuppressionType_Values() []string

SuppressionType_Values returns all elements of the SuppressionType enum

func SuppressionUnit_Values added in v1.48.4

func SuppressionUnit_Values() []string

SuppressionUnit_Values returns all elements of the SuppressionUnit enum

Types

type AccessDeniedException added in v1.47.8

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*AccessDeniedException) Code added in v1.47.8

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.47.8

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.47.8

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message added in v1.47.8

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.47.8

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.47.8

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.47.8

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.47.8

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccountPolicy added in v1.44.278

type AccountPolicy struct {

	// The Amazon Web Services account ID that the policy applies to.
	AccountId *string `locationName:"accountId" min:"12" type:"string"`

	// The date and time that this policy was most recently updated.
	LastUpdatedTime *int64 `locationName:"lastUpdatedTime" type:"long"`

	// The policy document for this account policy.
	//
	// The JSON specified in policyDocument can be up to 30,720 characters.
	PolicyDocument *string `locationName:"policyDocument" type:"string"`

	// The name of the account policy.
	PolicyName *string `locationName:"policyName" type:"string"`

	// The type of policy for this account policy.
	PolicyType *string `locationName:"policyType" type:"string" enum:"PolicyType"`

	// The scope of the account policy.
	Scope *string `locationName:"scope" type:"string" enum:"Scope"`

	// The log group selection criteria for this subscription filter policy.
	SelectionCriteria *string `locationName:"selectionCriteria" type:"string"`
	// contains filtered or unexported fields
}

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

func (AccountPolicy) GoString added in v1.44.278

func (s AccountPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountPolicy) SetAccountId added in v1.44.278

func (s *AccountPolicy) SetAccountId(v string) *AccountPolicy

SetAccountId sets the AccountId field's value.

func (*AccountPolicy) SetLastUpdatedTime added in v1.44.278

func (s *AccountPolicy) SetLastUpdatedTime(v int64) *AccountPolicy

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*AccountPolicy) SetPolicyDocument added in v1.44.278

func (s *AccountPolicy) SetPolicyDocument(v string) *AccountPolicy

SetPolicyDocument sets the PolicyDocument field's value.

func (*AccountPolicy) SetPolicyName added in v1.44.278

func (s *AccountPolicy) SetPolicyName(v string) *AccountPolicy

SetPolicyName sets the PolicyName field's value.

func (*AccountPolicy) SetPolicyType added in v1.44.278

func (s *AccountPolicy) SetPolicyType(v string) *AccountPolicy

SetPolicyType sets the PolicyType field's value.

func (*AccountPolicy) SetScope added in v1.44.278

func (s *AccountPolicy) SetScope(v string) *AccountPolicy

SetScope sets the Scope field's value.

func (*AccountPolicy) SetSelectionCriteria added in v1.49.18

func (s *AccountPolicy) SetSelectionCriteria(v string) *AccountPolicy

SetSelectionCriteria sets the SelectionCriteria field's value.

func (AccountPolicy) String added in v1.44.278

func (s AccountPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Anomaly added in v1.48.4

type Anomaly struct {

	// Specifies whether this anomaly is still ongoing.
	//
	// Active is a required field
	Active *bool `locationName:"active" type:"boolean" required:"true"`

	// The ARN of the anomaly detector that identified this anomaly.
	//
	// AnomalyDetectorArn is a required field
	AnomalyDetectorArn *string `locationName:"anomalyDetectorArn" min:"1" type:"string" required:"true"`

	// The unique ID that CloudWatch Logs assigned to this anomaly.
	//
	// AnomalyId is a required field
	AnomalyId *string `locationName:"anomalyId" min:"36" type:"string" required:"true"`

	// A human-readable description of the anomaly. This description is generated
	// by CloudWatch Logs.
	//
	// Description is a required field
	Description *string `locationName:"description" min:"1" type:"string" required:"true"`

	// 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.
	//
	// FirstSeen is a required field
	FirstSeen *int64 `locationName:"firstSeen" type:"long" required:"true"`

	// 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.
	//
	// Histogram is a required field
	Histogram map[string]*int64 `locationName:"histogram" type:"map" required:"true"`

	// 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 `locationName:"isPatternLevelSuppression" type:"boolean"`

	// 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.
	//
	// LastSeen is a required field
	LastSeen *int64 `locationName:"lastSeen" type:"long" required:"true"`

	// An array of ARNS of the log groups that contained log events considered to
	// be part of this anomaly.
	//
	// LogGroupArnList is a required field
	LogGroupArnList []*string `locationName:"logGroupArnList" type:"list" required:"true"`

	// An array of sample log event messages that are considered to be part of this
	// anomaly.
	//
	// LogSamples is a required field
	LogSamples []*LogEvent `locationName:"logSamples" type:"list" required:"true"`

	// The ID of the pattern used to help identify this anomaly.
	//
	// PatternId is a required field
	PatternId *string `locationName:"patternId" min:"32" type:"string" required:"true"`

	// The pattern used to help identify this anomaly, in regular expression format.
	PatternRegex *string `locationName:"patternRegex" min:"1" type:"string"`

	// The pattern used to help identify this anomaly, in string format.
	//
	// PatternString is a required field
	PatternString *string `locationName:"patternString" min:"1" type:"string" required:"true"`

	// An array of structures where each structure contains information about one
	// token that makes up the pattern.
	//
	// PatternTokens is a required field
	PatternTokens []*PatternToken `locationName:"patternTokens" type:"list" required:"true"`

	// 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 `locationName:"priority" min:"1" type:"string"`

	// 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 (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html)
	// operation, the value is Suppressed. If this behavior is now considered to
	// be normal, the value is Baseline.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"State"`

	// Indicates whether this anomaly is currently suppressed. To suppress an anomaly,
	// use UpdateAnomaly (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html).
	Suppressed *bool `locationName:"suppressed" type:"boolean"`

	// If the anomaly is suppressed, this indicates when it was suppressed.
	SuppressedDate *int64 `locationName:"suppressedDate" type:"long"`

	// 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 `locationName:"suppressedUntil" type:"long"`
	// 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 (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogAnomalyDetector.html).

func (Anomaly) GoString added in v1.48.4

func (s Anomaly) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Anomaly) SetActive added in v1.48.4

func (s *Anomaly) SetActive(v bool) *Anomaly

SetActive sets the Active field's value.

func (*Anomaly) SetAnomalyDetectorArn added in v1.48.4

func (s *Anomaly) SetAnomalyDetectorArn(v string) *Anomaly

SetAnomalyDetectorArn sets the AnomalyDetectorArn field's value.

func (*Anomaly) SetAnomalyId added in v1.48.4

func (s *Anomaly) SetAnomalyId(v string) *Anomaly

SetAnomalyId sets the AnomalyId field's value.

func (*Anomaly) SetDescription added in v1.48.4

func (s *Anomaly) SetDescription(v string) *Anomaly

SetDescription sets the Description field's value.

func (*Anomaly) SetFirstSeen added in v1.48.4

func (s *Anomaly) SetFirstSeen(v int64) *Anomaly

SetFirstSeen sets the FirstSeen field's value.

func (*Anomaly) SetHistogram added in v1.48.4

func (s *Anomaly) SetHistogram(v map[string]*int64) *Anomaly

SetHistogram sets the Histogram field's value.

func (*Anomaly) SetIsPatternLevelSuppression added in v1.48.4

func (s *Anomaly) SetIsPatternLevelSuppression(v bool) *Anomaly

SetIsPatternLevelSuppression sets the IsPatternLevelSuppression field's value.

func (*Anomaly) SetLastSeen added in v1.48.4

func (s *Anomaly) SetLastSeen(v int64) *Anomaly

SetLastSeen sets the LastSeen field's value.

func (*Anomaly) SetLogGroupArnList added in v1.48.4

func (s *Anomaly) SetLogGroupArnList(v []*string) *Anomaly

SetLogGroupArnList sets the LogGroupArnList field's value.

func (*Anomaly) SetLogSamples added in v1.48.4

func (s *Anomaly) SetLogSamples(v []*LogEvent) *Anomaly

SetLogSamples sets the LogSamples field's value.

func (*Anomaly) SetPatternId added in v1.48.4

func (s *Anomaly) SetPatternId(v string) *Anomaly

SetPatternId sets the PatternId field's value.

func (*Anomaly) SetPatternRegex added in v1.48.4

func (s *Anomaly) SetPatternRegex(v string) *Anomaly

SetPatternRegex sets the PatternRegex field's value.

func (*Anomaly) SetPatternString added in v1.48.4

func (s *Anomaly) SetPatternString(v string) *Anomaly

SetPatternString sets the PatternString field's value.

func (*Anomaly) SetPatternTokens added in v1.48.4

func (s *Anomaly) SetPatternTokens(v []*PatternToken) *Anomaly

SetPatternTokens sets the PatternTokens field's value.

func (*Anomaly) SetPriority added in v1.48.4

func (s *Anomaly) SetPriority(v string) *Anomaly

SetPriority sets the Priority field's value.

func (*Anomaly) SetState added in v1.48.4

func (s *Anomaly) SetState(v string) *Anomaly

SetState sets the State field's value.

func (*Anomaly) SetSuppressed added in v1.48.4

func (s *Anomaly) SetSuppressed(v bool) *Anomaly

SetSuppressed sets the Suppressed field's value.

func (*Anomaly) SetSuppressedDate added in v1.48.4

func (s *Anomaly) SetSuppressedDate(v int64) *Anomaly

SetSuppressedDate sets the SuppressedDate field's value.

func (*Anomaly) SetSuppressedUntil added in v1.48.4

func (s *Anomaly) SetSuppressedUntil(v int64) *Anomaly

SetSuppressedUntil sets the SuppressedUntil field's value.

func (Anomaly) String added in v1.48.4

func (s Anomaly) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AnomalyDetector added in v1.48.4

type AnomalyDetector struct {

	// The ARN of the anomaly detector.
	AnomalyDetectorArn *string `locationName:"anomalyDetectorArn" min:"1" type:"string"`

	// Specifies the current status of the anomaly detector. To pause an anomaly
	// detector, use the enabled parameter in the UpdateLogAnomalyDetector (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html)
	// operation.
	AnomalyDetectorStatus *string `locationName:"anomalyDetectorStatus" type:"string" enum:"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 `locationName:"anomalyVisibilityTime" min:"7" type:"long"`

	// The date and time when this anomaly detector was created.
	CreationTimeStamp *int64 `locationName:"creationTimeStamp" type:"long"`

	// The name of the anomaly detector.
	DetectorName *string `locationName:"detectorName" min:"1" type:"string"`

	// Specifies how often the anomaly detector runs and look for anomalies.
	EvaluationFrequency *string `locationName:"evaluationFrequency" type:"string" enum:"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 `locationName:"filterPattern" type:"string"`

	// The ID of the KMS key assigned to this anomaly detector, if any.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// The date and time when this anomaly detector was most recently modified.
	LastModifiedTimeStamp *int64 `locationName:"lastModifiedTimeStamp" type:"long"`

	// A list of the ARNs of the log groups that this anomaly detector watches.
	LogGroupArnList []*string `locationName:"logGroupArnList" type:"list"`
	// contains filtered or unexported fields
}

Contains information about one anomaly detector in the account.

func (AnomalyDetector) GoString added in v1.48.4

func (s AnomalyDetector) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnomalyDetector) SetAnomalyDetectorArn added in v1.48.4

func (s *AnomalyDetector) SetAnomalyDetectorArn(v string) *AnomalyDetector

SetAnomalyDetectorArn sets the AnomalyDetectorArn field's value.

func (*AnomalyDetector) SetAnomalyDetectorStatus added in v1.48.4

func (s *AnomalyDetector) SetAnomalyDetectorStatus(v string) *AnomalyDetector

SetAnomalyDetectorStatus sets the AnomalyDetectorStatus field's value.

func (*AnomalyDetector) SetAnomalyVisibilityTime added in v1.48.4

func (s *AnomalyDetector) SetAnomalyVisibilityTime(v int64) *AnomalyDetector

SetAnomalyVisibilityTime sets the AnomalyVisibilityTime field's value.

func (*AnomalyDetector) SetCreationTimeStamp added in v1.48.4

func (s *AnomalyDetector) SetCreationTimeStamp(v int64) *AnomalyDetector

SetCreationTimeStamp sets the CreationTimeStamp field's value.

func (*AnomalyDetector) SetDetectorName added in v1.48.4

func (s *AnomalyDetector) SetDetectorName(v string) *AnomalyDetector

SetDetectorName sets the DetectorName field's value.

func (*AnomalyDetector) SetEvaluationFrequency added in v1.48.4

func (s *AnomalyDetector) SetEvaluationFrequency(v string) *AnomalyDetector

SetEvaluationFrequency sets the EvaluationFrequency field's value.

func (*AnomalyDetector) SetFilterPattern added in v1.48.4

func (s *AnomalyDetector) SetFilterPattern(v string) *AnomalyDetector

SetFilterPattern sets the FilterPattern field's value.

func (*AnomalyDetector) SetKmsKeyId added in v1.48.4

func (s *AnomalyDetector) SetKmsKeyId(v string) *AnomalyDetector

SetKmsKeyId sets the KmsKeyId field's value.

func (*AnomalyDetector) SetLastModifiedTimeStamp added in v1.48.4

func (s *AnomalyDetector) SetLastModifiedTimeStamp(v int64) *AnomalyDetector

SetLastModifiedTimeStamp sets the LastModifiedTimeStamp field's value.

func (*AnomalyDetector) SetLogGroupArnList added in v1.48.4

func (s *AnomalyDetector) SetLogGroupArnList(v []*string) *AnomalyDetector

SetLogGroupArnList sets the LogGroupArnList field's value.

func (AnomalyDetector) String added in v1.48.4

func (s AnomalyDetector) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateKmsKeyInput added in v1.10.50

type AssociateKmsKeyInput struct {

	// The Amazon Resource Name (ARN) of the KMS key to use when encrypting log
	// data. This must be a symmetric KMS key. For more information, see Amazon
	// Resource Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms)
	// and Using Symmetric and Asymmetric Keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html).
	//
	// KmsKeyId is a required field
	KmsKeyId *string `locationName:"kmsKeyId" type:"string" required:"true"`

	// The name of the log group.
	//
	// In your AssociateKmsKey operation, you must specify either the resourceIdentifier
	// parameter or the logGroup parameter, but you can't specify both.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// Specifies the target for this operation. You must specify one of the following:
	//
	//    * Specify the following ARN to have future GetQueryResults (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html)
	//    operations in this account encrypt the results with the specified KMS
	//    key. Replace REGION and ACCOUNT_ID with your Region and account ID. arn:aws:logs:REGION:ACCOUNT_ID:query-result:*
	//
	//    * Specify the ARN of a log group to have CloudWatch Logs use the KMS key
	//    to encrypt log events that are ingested and stored by that log group.
	//    The log group ARN must be in the following format. Replace REGION and
	//    ACCOUNT_ID with your Region and account ID. arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME
	//
	// In your AssociateKmsKey operation, you must specify either the resourceIdentifier
	// parameter or the logGroup parameter, but you can't specify both.
	ResourceIdentifier *string `locationName:"resourceIdentifier" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (AssociateKmsKeyInput) GoString added in v1.10.50

func (s AssociateKmsKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateKmsKeyInput) SetKmsKeyId added in v1.10.50

SetKmsKeyId sets the KmsKeyId field's value.

func (*AssociateKmsKeyInput) SetLogGroupName added in v1.10.50

func (s *AssociateKmsKeyInput) SetLogGroupName(v string) *AssociateKmsKeyInput

SetLogGroupName sets the LogGroupName field's value.

func (*AssociateKmsKeyInput) SetResourceIdentifier added in v1.44.298

func (s *AssociateKmsKeyInput) SetResourceIdentifier(v string) *AssociateKmsKeyInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (AssociateKmsKeyInput) String added in v1.10.50

func (s AssociateKmsKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateKmsKeyInput) Validate added in v1.10.50

func (s *AssociateKmsKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateKmsKeyOutput added in v1.10.50

type AssociateKmsKeyOutput struct {
	// contains filtered or unexported fields
}

func (AssociateKmsKeyOutput) GoString added in v1.10.50

func (s AssociateKmsKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AssociateKmsKeyOutput) String added in v1.10.50

func (s AssociateKmsKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelExportTaskInput added in v0.9.9

type CancelExportTaskInput struct {

	// The ID of the export task.
	//
	// TaskId is a required field
	TaskId *string `locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelExportTaskInput) GoString added in v0.9.9

func (s CancelExportTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelExportTaskInput) SetTaskId added in v1.5.0

SetTaskId sets the TaskId field's value.

func (CancelExportTaskInput) String added in v0.9.9

func (s CancelExportTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelExportTaskInput) Validate added in v1.1.21

func (s *CancelExportTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelExportTaskOutput added in v0.9.9

type CancelExportTaskOutput struct {
	// contains filtered or unexported fields
}

func (CancelExportTaskOutput) GoString added in v0.9.9

func (s CancelExportTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CancelExportTaskOutput) String added in v0.9.9

func (s CancelExportTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudWatchLogs

type CloudWatchLogs struct {
	*client.Client
}

CloudWatchLogs provides the API operation methods for making requests to Amazon CloudWatch Logs. See this package's package overview docs for details on the service.

CloudWatchLogs methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CloudWatchLogs

New creates a new instance of the CloudWatchLogs client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a CloudWatchLogs client from just a session.
svc := cloudwatchlogs.New(mySession)

// Create a CloudWatchLogs client with additional configuration
svc := cloudwatchlogs.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CloudWatchLogs) AssociateKmsKey added in v1.10.50

func (c *CloudWatchLogs) AssociateKmsKey(input *AssociateKmsKeyInput) (*AssociateKmsKeyOutput, error)

AssociateKmsKey API operation for Amazon CloudWatch Logs.

Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.

When you use AssociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.

  • Specify the logGroupName parameter to cause all log events stored in the log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key. Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier parameter that specifies a query-result resource.

  • Specify the resourceIdentifier parameter with a query-result resource, to use that key to encrypt the stored results of all future StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html) operations in the account. The response from a GetQueryResults (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html) operation will still return the query results in plain text. Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method. If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.

If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.

CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html).

It can take up to 5 minutes for this operation to take effect.

If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation AssociateKmsKey for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AssociateKmsKey

func (*CloudWatchLogs) AssociateKmsKeyRequest added in v1.10.50

func (c *CloudWatchLogs) AssociateKmsKeyRequest(input *AssociateKmsKeyInput) (req *request.Request, output *AssociateKmsKeyOutput)

AssociateKmsKeyRequest generates a "aws/request.Request" representing the client's request for the AssociateKmsKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateKmsKey for more information on using the AssociateKmsKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AssociateKmsKeyRequest method.
req, resp := client.AssociateKmsKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AssociateKmsKey

func (*CloudWatchLogs) AssociateKmsKeyWithContext added in v1.10.50

func (c *CloudWatchLogs) AssociateKmsKeyWithContext(ctx aws.Context, input *AssociateKmsKeyInput, opts ...request.Option) (*AssociateKmsKeyOutput, error)

AssociateKmsKeyWithContext is the same as AssociateKmsKey with the addition of the ability to pass a context and additional request options.

See AssociateKmsKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) CancelExportTask added in v0.9.9

func (c *CloudWatchLogs) CancelExportTask(input *CancelExportTaskInput) (*CancelExportTaskOutput, error)

CancelExportTask API operation for Amazon CloudWatch Logs.

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation CancelExportTask for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidOperationException The operation is not valid on the specified resource.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CancelExportTask

func (*CloudWatchLogs) CancelExportTaskRequest added in v0.9.9

func (c *CloudWatchLogs) CancelExportTaskRequest(input *CancelExportTaskInput) (req *request.Request, output *CancelExportTaskOutput)

CancelExportTaskRequest generates a "aws/request.Request" representing the client's request for the CancelExportTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelExportTask for more information on using the CancelExportTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CancelExportTaskRequest method.
req, resp := client.CancelExportTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CancelExportTask

func (*CloudWatchLogs) CancelExportTaskWithContext added in v1.8.0

func (c *CloudWatchLogs) CancelExportTaskWithContext(ctx aws.Context, input *CancelExportTaskInput, opts ...request.Option) (*CancelExportTaskOutput, error)

CancelExportTaskWithContext is the same as CancelExportTask with the addition of the ability to pass a context and additional request options.

See CancelExportTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) CreateDelivery added in v1.47.8

func (c *CloudWatchLogs) CreateDelivery(input *CreateDeliveryInput) (*CreateDeliveryOutput, error)

CreateDelivery API operation for Amazon CloudWatch Logs.

Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.

Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html)

A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.

To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:

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.

You can't update an existing delivery. You can only create and delete deliveries.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation CreateDelivery for usage and error information.

Returned Error Types:

  • ServiceUnavailableException The service cannot complete the request.

  • ConflictException This operation attempted to create a resource that already exists.

  • ResourceNotFoundException The specified resource does not exist.

  • ValidationException One of the parameters for the request is not valid.

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

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ThrottlingException The request was throttled because of quota limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateDelivery

func (*CloudWatchLogs) CreateDeliveryRequest added in v1.47.8

func (c *CloudWatchLogs) CreateDeliveryRequest(input *CreateDeliveryInput) (req *request.Request, output *CreateDeliveryOutput)

CreateDeliveryRequest generates a "aws/request.Request" representing the client's request for the CreateDelivery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDelivery for more information on using the CreateDelivery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDeliveryRequest method.
req, resp := client.CreateDeliveryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateDelivery

func (*CloudWatchLogs) CreateDeliveryWithContext added in v1.47.8

func (c *CloudWatchLogs) CreateDeliveryWithContext(ctx aws.Context, input *CreateDeliveryInput, opts ...request.Option) (*CreateDeliveryOutput, error)

CreateDeliveryWithContext is the same as CreateDelivery with the addition of the ability to pass a context and additional request options.

See CreateDelivery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) CreateExportTask added in v0.9.9

func (c *CloudWatchLogs) CreateExportTask(input *CreateExportTaskInput) (*CreateExportTaskOutput, error)

CreateExportTask API operation for Amazon CloudWatch Logs.

Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.

Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.

Exporting to S3 buckets that are encrypted with AES-256 is supported.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html) to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html).

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation CreateExportTask for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

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

  • ServiceUnavailableException The service cannot complete the request.

  • ResourceNotFoundException The specified resource does not exist.

  • ResourceAlreadyExistsException The specified resource already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateExportTask

func (*CloudWatchLogs) CreateExportTaskRequest added in v0.9.9

func (c *CloudWatchLogs) CreateExportTaskRequest(input *CreateExportTaskInput) (req *request.Request, output *CreateExportTaskOutput)

CreateExportTaskRequest generates a "aws/request.Request" representing the client's request for the CreateExportTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateExportTask for more information on using the CreateExportTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateExportTaskRequest method.
req, resp := client.CreateExportTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateExportTask

func (*CloudWatchLogs) CreateExportTaskWithContext added in v1.8.0

func (c *CloudWatchLogs) CreateExportTaskWithContext(ctx aws.Context, input *CreateExportTaskInput, opts ...request.Option) (*CreateExportTaskOutput, error)

CreateExportTaskWithContext is the same as CreateExportTask with the addition of the ability to pass a context and additional request options.

See CreateExportTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) CreateLogAnomalyDetector added in v1.48.4

func (c *CloudWatchLogs) CreateLogAnomalyDetector(input *CreateLogAnomalyDetectorInput) (*CreateLogAnomalyDetectorOutput, error)

CreateLogAnomalyDetector API operation for Amazon CloudWatch Logs.

Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.

An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns.

The anomaly detector uses pattern recognition to find anomalies, which are unusual log events. It uses the evaluationFrequency to compare current log events and patterns with trained baselines.

Fields within a pattern are called tokens. Fields that vary within a pattern, such as a request ID or timestamp, are referred to as dynamic tokens and represented by <*>.

The following is an example of a pattern:

[INFO] Request time: <*> ms

This pattern represents log events like [INFO] Request time: 327 ms and other similar log events that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced by <*>

Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information about masking sensitive data, see Help protect sensitive log data with masking (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation CreateLogAnomalyDetector for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogAnomalyDetector

func (*CloudWatchLogs) CreateLogAnomalyDetectorRequest added in v1.48.4

func (c *CloudWatchLogs) CreateLogAnomalyDetectorRequest(input *CreateLogAnomalyDetectorInput) (req *request.Request, output *CreateLogAnomalyDetectorOutput)

CreateLogAnomalyDetectorRequest generates a "aws/request.Request" representing the client's request for the CreateLogAnomalyDetector operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLogAnomalyDetector for more information on using the CreateLogAnomalyDetector API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLogAnomalyDetectorRequest method.
req, resp := client.CreateLogAnomalyDetectorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogAnomalyDetector

func (*CloudWatchLogs) CreateLogAnomalyDetectorWithContext added in v1.48.4

func (c *CloudWatchLogs) CreateLogAnomalyDetectorWithContext(ctx aws.Context, input *CreateLogAnomalyDetectorInput, opts ...request.Option) (*CreateLogAnomalyDetectorOutput, error)

CreateLogAnomalyDetectorWithContext is the same as CreateLogAnomalyDetector with the addition of the ability to pass a context and additional request options.

See CreateLogAnomalyDetector for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) CreateLogGroup

func (c *CloudWatchLogs) CreateLogGroup(input *CreateLogGroupInput) (*CreateLogGroupOutput, error)

CreateLogGroup API operation for Amazon CloudWatch Logs.

Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.

You must use the following guidelines when naming a log group:

  • Log group names must be unique within a Region for an Amazon Web Services account.

  • Log group names can be between 1 and 512 characters long.

  • Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign)

  • Log group names can't start with the string aws/

When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html).

If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation CreateLogGroup for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceAlreadyExistsException The specified resource already exists.

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

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogGroup

func (*CloudWatchLogs) CreateLogGroupRequest

func (c *CloudWatchLogs) CreateLogGroupRequest(input *CreateLogGroupInput) (req *request.Request, output *CreateLogGroupOutput)

CreateLogGroupRequest generates a "aws/request.Request" representing the client's request for the CreateLogGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLogGroup for more information on using the CreateLogGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLogGroupRequest method.
req, resp := client.CreateLogGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogGroup

func (*CloudWatchLogs) CreateLogGroupWithContext added in v1.8.0

func (c *CloudWatchLogs) CreateLogGroupWithContext(ctx aws.Context, input *CreateLogGroupInput, opts ...request.Option) (*CreateLogGroupOutput, error)

CreateLogGroupWithContext is the same as CreateLogGroup with the addition of the ability to pass a context and additional request options.

See CreateLogGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) CreateLogStream

func (c *CloudWatchLogs) CreateLogStream(input *CreateLogStreamInput) (*CreateLogStreamOutput, error)

CreateLogStream API operation for Amazon CloudWatch Logs.

Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.

There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.

You must use the following guidelines when naming a log stream:

  • Log stream names must be unique within the log group.

  • Log stream names can be between 1 and 512 characters long.

  • Don't use ':' (colon) or '*' (asterisk) characters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation CreateLogStream for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceAlreadyExistsException The specified resource already exists.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogStream

func (*CloudWatchLogs) CreateLogStreamRequest

func (c *CloudWatchLogs) CreateLogStreamRequest(input *CreateLogStreamInput) (req *request.Request, output *CreateLogStreamOutput)

CreateLogStreamRequest generates a "aws/request.Request" representing the client's request for the CreateLogStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLogStream for more information on using the CreateLogStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLogStreamRequest method.
req, resp := client.CreateLogStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogStream

func (*CloudWatchLogs) CreateLogStreamWithContext added in v1.8.0

func (c *CloudWatchLogs) CreateLogStreamWithContext(ctx aws.Context, input *CreateLogStreamInput, opts ...request.Option) (*CreateLogStreamOutput, error)

CreateLogStreamWithContext is the same as CreateLogStream with the addition of the ability to pass a context and additional request options.

See CreateLogStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteAccountPolicy added in v1.44.278

func (c *CloudWatchLogs) DeleteAccountPolicy(input *DeleteAccountPolicyInput) (*DeleteAccountPolicyOutput, error)

DeleteAccountPolicy API operation for Amazon CloudWatch Logs.

Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups or a subset of log groups in the account. Log-group level policies will still be in effect.

To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting.

  • To delete a data protection policy, you must have the logs:DeleteDataProtectionPolicy and logs:DeleteAccountPolicy permissions.

  • To delete a subscription filter policy, you must have the logs:DeleteSubscriptionFilter and logs:DeleteAccountPolicy permissions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteAccountPolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteAccountPolicy

func (*CloudWatchLogs) DeleteAccountPolicyRequest added in v1.44.278

func (c *CloudWatchLogs) DeleteAccountPolicyRequest(input *DeleteAccountPolicyInput) (req *request.Request, output *DeleteAccountPolicyOutput)

DeleteAccountPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteAccountPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAccountPolicy for more information on using the DeleteAccountPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAccountPolicyRequest method.
req, resp := client.DeleteAccountPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteAccountPolicy

func (*CloudWatchLogs) DeleteAccountPolicyWithContext added in v1.44.278

func (c *CloudWatchLogs) DeleteAccountPolicyWithContext(ctx aws.Context, input *DeleteAccountPolicyInput, opts ...request.Option) (*DeleteAccountPolicyOutput, error)

DeleteAccountPolicyWithContext is the same as DeleteAccountPolicy with the addition of the ability to pass a context and additional request options.

See DeleteAccountPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteDataProtectionPolicy added in v1.44.146

DeleteDataProtectionPolicy API operation for Amazon CloudWatch Logs.

Deletes the data protection policy from the specified log group.

For more information about data protection policies, see PutDataProtectionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteDataProtectionPolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDataProtectionPolicy

func (*CloudWatchLogs) DeleteDataProtectionPolicyRequest added in v1.44.146

func (c *CloudWatchLogs) DeleteDataProtectionPolicyRequest(input *DeleteDataProtectionPolicyInput) (req *request.Request, output *DeleteDataProtectionPolicyOutput)

DeleteDataProtectionPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteDataProtectionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDataProtectionPolicy for more information on using the DeleteDataProtectionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDataProtectionPolicyRequest method.
req, resp := client.DeleteDataProtectionPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDataProtectionPolicy

func (*CloudWatchLogs) DeleteDataProtectionPolicyWithContext added in v1.44.146

func (c *CloudWatchLogs) DeleteDataProtectionPolicyWithContext(ctx aws.Context, input *DeleteDataProtectionPolicyInput, opts ...request.Option) (*DeleteDataProtectionPolicyOutput, error)

DeleteDataProtectionPolicyWithContext is the same as DeleteDataProtectionPolicy with the addition of the ability to pass a context and additional request options.

See DeleteDataProtectionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteDelivery added in v1.47.8

func (c *CloudWatchLogs) DeleteDelivery(input *DeleteDeliveryInput) (*DeleteDeliveryOutput, error)

DeleteDelivery API operation for Amazon CloudWatch Logs.

Deletes s delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteDelivery for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

  • ConflictException This operation attempted to create a resource that already exists.

  • ValidationException One of the parameters for the request is not valid.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ThrottlingException The request was throttled because of quota limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDelivery

func (*CloudWatchLogs) DeleteDeliveryDestination added in v1.47.8

DeleteDeliveryDestination API operation for Amazon CloudWatch Logs.

Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination.

You can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html) operation and check the deliveryDestinationArn field in the results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteDeliveryDestination for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

  • ConflictException This operation attempted to create a resource that already exists.

  • ValidationException One of the parameters for the request is not valid.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ThrottlingException The request was throttled because of quota limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDeliveryDestination

func (*CloudWatchLogs) DeleteDeliveryDestinationPolicy added in v1.47.8

DeleteDeliveryDestinationPolicy API operation for Amazon CloudWatch Logs.

Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteDeliveryDestinationPolicy for usage and error information.

Returned Error Types:

  • ServiceUnavailableException The service cannot complete the request.

  • ValidationException One of the parameters for the request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ConflictException This operation attempted to create a resource that already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDeliveryDestinationPolicy

func (*CloudWatchLogs) DeleteDeliveryDestinationPolicyRequest added in v1.47.8

func (c *CloudWatchLogs) DeleteDeliveryDestinationPolicyRequest(input *DeleteDeliveryDestinationPolicyInput) (req *request.Request, output *DeleteDeliveryDestinationPolicyOutput)

DeleteDeliveryDestinationPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteDeliveryDestinationPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDeliveryDestinationPolicy for more information on using the DeleteDeliveryDestinationPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDeliveryDestinationPolicyRequest method.
req, resp := client.DeleteDeliveryDestinationPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDeliveryDestinationPolicy

func (*CloudWatchLogs) DeleteDeliveryDestinationPolicyWithContext added in v1.47.8

func (c *CloudWatchLogs) DeleteDeliveryDestinationPolicyWithContext(ctx aws.Context, input *DeleteDeliveryDestinationPolicyInput, opts ...request.Option) (*DeleteDeliveryDestinationPolicyOutput, error)

DeleteDeliveryDestinationPolicyWithContext is the same as DeleteDeliveryDestinationPolicy with the addition of the ability to pass a context and additional request options.

See DeleteDeliveryDestinationPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteDeliveryDestinationRequest added in v1.47.8

func (c *CloudWatchLogs) DeleteDeliveryDestinationRequest(input *DeleteDeliveryDestinationInput) (req *request.Request, output *DeleteDeliveryDestinationOutput)

DeleteDeliveryDestinationRequest generates a "aws/request.Request" representing the client's request for the DeleteDeliveryDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDeliveryDestination for more information on using the DeleteDeliveryDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDeliveryDestinationRequest method.
req, resp := client.DeleteDeliveryDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDeliveryDestination

func (*CloudWatchLogs) DeleteDeliveryDestinationWithContext added in v1.47.8

func (c *CloudWatchLogs) DeleteDeliveryDestinationWithContext(ctx aws.Context, input *DeleteDeliveryDestinationInput, opts ...request.Option) (*DeleteDeliveryDestinationOutput, error)

DeleteDeliveryDestinationWithContext is the same as DeleteDeliveryDestination with the addition of the ability to pass a context and additional request options.

See DeleteDeliveryDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteDeliveryRequest added in v1.47.8

func (c *CloudWatchLogs) DeleteDeliveryRequest(input *DeleteDeliveryInput) (req *request.Request, output *DeleteDeliveryOutput)

DeleteDeliveryRequest generates a "aws/request.Request" representing the client's request for the DeleteDelivery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDelivery for more information on using the DeleteDelivery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDeliveryRequest method.
req, resp := client.DeleteDeliveryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDelivery

func (*CloudWatchLogs) DeleteDeliverySource added in v1.47.8

func (c *CloudWatchLogs) DeleteDeliverySource(input *DeleteDeliverySourceInput) (*DeleteDeliverySourceOutput, error)

DeleteDeliverySource API operation for Amazon CloudWatch Logs.

Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination.

You can't delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery source, use the DescribeDeliveries (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html) operation and check the deliverySourceName field in the results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteDeliverySource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

  • ConflictException This operation attempted to create a resource that already exists.

  • ValidationException One of the parameters for the request is not valid.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ThrottlingException The request was throttled because of quota limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDeliverySource

func (*CloudWatchLogs) DeleteDeliverySourceRequest added in v1.47.8

func (c *CloudWatchLogs) DeleteDeliverySourceRequest(input *DeleteDeliverySourceInput) (req *request.Request, output *DeleteDeliverySourceOutput)

DeleteDeliverySourceRequest generates a "aws/request.Request" representing the client's request for the DeleteDeliverySource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDeliverySource for more information on using the DeleteDeliverySource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDeliverySourceRequest method.
req, resp := client.DeleteDeliverySourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDeliverySource

func (*CloudWatchLogs) DeleteDeliverySourceWithContext added in v1.47.8

func (c *CloudWatchLogs) DeleteDeliverySourceWithContext(ctx aws.Context, input *DeleteDeliverySourceInput, opts ...request.Option) (*DeleteDeliverySourceOutput, error)

DeleteDeliverySourceWithContext is the same as DeleteDeliverySource with the addition of the ability to pass a context and additional request options.

See DeleteDeliverySource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteDeliveryWithContext added in v1.47.8

func (c *CloudWatchLogs) DeleteDeliveryWithContext(ctx aws.Context, input *DeleteDeliveryInput, opts ...request.Option) (*DeleteDeliveryOutput, error)

DeleteDeliveryWithContext is the same as DeleteDelivery with the addition of the ability to pass a context and additional request options.

See DeleteDelivery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteDestination added in v0.7.1

func (c *CloudWatchLogs) DeleteDestination(input *DeleteDestinationInput) (*DeleteDestinationOutput, error)

DeleteDestination API operation for Amazon CloudWatch Logs.

Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteDestination for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDestination

func (*CloudWatchLogs) DeleteDestinationRequest added in v0.7.1

func (c *CloudWatchLogs) DeleteDestinationRequest(input *DeleteDestinationInput) (req *request.Request, output *DeleteDestinationOutput)

DeleteDestinationRequest generates a "aws/request.Request" representing the client's request for the DeleteDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDestination for more information on using the DeleteDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDestinationRequest method.
req, resp := client.DeleteDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDestination

func (*CloudWatchLogs) DeleteDestinationWithContext added in v1.8.0

func (c *CloudWatchLogs) DeleteDestinationWithContext(ctx aws.Context, input *DeleteDestinationInput, opts ...request.Option) (*DeleteDestinationOutput, error)

DeleteDestinationWithContext is the same as DeleteDestination with the addition of the ability to pass a context and additional request options.

See DeleteDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteLogAnomalyDetector added in v1.48.4

func (c *CloudWatchLogs) DeleteLogAnomalyDetector(input *DeleteLogAnomalyDetectorInput) (*DeleteLogAnomalyDetectorOutput, error)

DeleteLogAnomalyDetector API operation for Amazon CloudWatch Logs.

Deletes the specified CloudWatch Logs anomaly detector.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteLogAnomalyDetector for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogAnomalyDetector

func (*CloudWatchLogs) DeleteLogAnomalyDetectorRequest added in v1.48.4

func (c *CloudWatchLogs) DeleteLogAnomalyDetectorRequest(input *DeleteLogAnomalyDetectorInput) (req *request.Request, output *DeleteLogAnomalyDetectorOutput)

DeleteLogAnomalyDetectorRequest generates a "aws/request.Request" representing the client's request for the DeleteLogAnomalyDetector operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLogAnomalyDetector for more information on using the DeleteLogAnomalyDetector API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLogAnomalyDetectorRequest method.
req, resp := client.DeleteLogAnomalyDetectorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogAnomalyDetector

func (*CloudWatchLogs) DeleteLogAnomalyDetectorWithContext added in v1.48.4

func (c *CloudWatchLogs) DeleteLogAnomalyDetectorWithContext(ctx aws.Context, input *DeleteLogAnomalyDetectorInput, opts ...request.Option) (*DeleteLogAnomalyDetectorOutput, error)

DeleteLogAnomalyDetectorWithContext is the same as DeleteLogAnomalyDetector with the addition of the ability to pass a context and additional request options.

See DeleteLogAnomalyDetector for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteLogGroup

func (c *CloudWatchLogs) DeleteLogGroup(input *DeleteLogGroupInput) (*DeleteLogGroupOutput, error)

DeleteLogGroup API operation for Amazon CloudWatch Logs.

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteLogGroup for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogGroup

func (*CloudWatchLogs) DeleteLogGroupRequest

func (c *CloudWatchLogs) DeleteLogGroupRequest(input *DeleteLogGroupInput) (req *request.Request, output *DeleteLogGroupOutput)

DeleteLogGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteLogGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLogGroup for more information on using the DeleteLogGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLogGroupRequest method.
req, resp := client.DeleteLogGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogGroup

func (*CloudWatchLogs) DeleteLogGroupWithContext added in v1.8.0

func (c *CloudWatchLogs) DeleteLogGroupWithContext(ctx aws.Context, input *DeleteLogGroupInput, opts ...request.Option) (*DeleteLogGroupOutput, error)

DeleteLogGroupWithContext is the same as DeleteLogGroup with the addition of the ability to pass a context and additional request options.

See DeleteLogGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteLogStream

func (c *CloudWatchLogs) DeleteLogStream(input *DeleteLogStreamInput) (*DeleteLogStreamOutput, error)

DeleteLogStream API operation for Amazon CloudWatch Logs.

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteLogStream for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogStream

func (*CloudWatchLogs) DeleteLogStreamRequest

func (c *CloudWatchLogs) DeleteLogStreamRequest(input *DeleteLogStreamInput) (req *request.Request, output *DeleteLogStreamOutput)

DeleteLogStreamRequest generates a "aws/request.Request" representing the client's request for the DeleteLogStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLogStream for more information on using the DeleteLogStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLogStreamRequest method.
req, resp := client.DeleteLogStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogStream

func (*CloudWatchLogs) DeleteLogStreamWithContext added in v1.8.0

func (c *CloudWatchLogs) DeleteLogStreamWithContext(ctx aws.Context, input *DeleteLogStreamInput, opts ...request.Option) (*DeleteLogStreamOutput, error)

DeleteLogStreamWithContext is the same as DeleteLogStream with the addition of the ability to pass a context and additional request options.

See DeleteLogStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteMetricFilter

func (c *CloudWatchLogs) DeleteMetricFilter(input *DeleteMetricFilterInput) (*DeleteMetricFilterOutput, error)

DeleteMetricFilter API operation for Amazon CloudWatch Logs.

Deletes the specified metric filter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteMetricFilter for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteMetricFilter

func (*CloudWatchLogs) DeleteMetricFilterRequest

func (c *CloudWatchLogs) DeleteMetricFilterRequest(input *DeleteMetricFilterInput) (req *request.Request, output *DeleteMetricFilterOutput)

DeleteMetricFilterRequest generates a "aws/request.Request" representing the client's request for the DeleteMetricFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMetricFilter for more information on using the DeleteMetricFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteMetricFilterRequest method.
req, resp := client.DeleteMetricFilterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteMetricFilter

func (*CloudWatchLogs) DeleteMetricFilterWithContext added in v1.8.0

func (c *CloudWatchLogs) DeleteMetricFilterWithContext(ctx aws.Context, input *DeleteMetricFilterInput, opts ...request.Option) (*DeleteMetricFilterOutput, error)

DeleteMetricFilterWithContext is the same as DeleteMetricFilter with the addition of the ability to pass a context and additional request options.

See DeleteMetricFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteQueryDefinition added in v1.30.23

func (c *CloudWatchLogs) DeleteQueryDefinition(input *DeleteQueryDefinitionInput) (*DeleteQueryDefinitionOutput, error)

DeleteQueryDefinition API operation for Amazon CloudWatch Logs.

Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.

Each DeleteQueryDefinition operation can delete one query definition.

You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteQueryDefinition for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteQueryDefinition

func (*CloudWatchLogs) DeleteQueryDefinitionRequest added in v1.30.23

func (c *CloudWatchLogs) DeleteQueryDefinitionRequest(input *DeleteQueryDefinitionInput) (req *request.Request, output *DeleteQueryDefinitionOutput)

DeleteQueryDefinitionRequest generates a "aws/request.Request" representing the client's request for the DeleteQueryDefinition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteQueryDefinition for more information on using the DeleteQueryDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteQueryDefinitionRequest method.
req, resp := client.DeleteQueryDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteQueryDefinition

func (*CloudWatchLogs) DeleteQueryDefinitionWithContext added in v1.30.23

func (c *CloudWatchLogs) DeleteQueryDefinitionWithContext(ctx aws.Context, input *DeleteQueryDefinitionInput, opts ...request.Option) (*DeleteQueryDefinitionOutput, error)

DeleteQueryDefinitionWithContext is the same as DeleteQueryDefinition with the addition of the ability to pass a context and additional request options.

See DeleteQueryDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteResourcePolicy added in v1.10.41

func (c *CloudWatchLogs) DeleteResourcePolicy(input *DeleteResourcePolicyInput) (*DeleteResourcePolicyOutput, error)

DeleteResourcePolicy API operation for Amazon CloudWatch Logs.

Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteResourcePolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteResourcePolicy

func (*CloudWatchLogs) DeleteResourcePolicyRequest added in v1.10.41

func (c *CloudWatchLogs) DeleteResourcePolicyRequest(input *DeleteResourcePolicyInput) (req *request.Request, output *DeleteResourcePolicyOutput)

DeleteResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteResourcePolicy for more information on using the DeleteResourcePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteResourcePolicyRequest method.
req, resp := client.DeleteResourcePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteResourcePolicy

func (*CloudWatchLogs) DeleteResourcePolicyWithContext added in v1.10.41

func (c *CloudWatchLogs) DeleteResourcePolicyWithContext(ctx aws.Context, input *DeleteResourcePolicyInput, opts ...request.Option) (*DeleteResourcePolicyOutput, error)

DeleteResourcePolicyWithContext is the same as DeleteResourcePolicy with the addition of the ability to pass a context and additional request options.

See DeleteResourcePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteRetentionPolicy

func (c *CloudWatchLogs) DeleteRetentionPolicy(input *DeleteRetentionPolicyInput) (*DeleteRetentionPolicyOutput, error)

DeleteRetentionPolicy API operation for Amazon CloudWatch Logs.

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteRetentionPolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteRetentionPolicy

func (*CloudWatchLogs) DeleteRetentionPolicyRequest

func (c *CloudWatchLogs) DeleteRetentionPolicyRequest(input *DeleteRetentionPolicyInput) (req *request.Request, output *DeleteRetentionPolicyOutput)

DeleteRetentionPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteRetentionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRetentionPolicy for more information on using the DeleteRetentionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRetentionPolicyRequest method.
req, resp := client.DeleteRetentionPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteRetentionPolicy

func (*CloudWatchLogs) DeleteRetentionPolicyWithContext added in v1.8.0

func (c *CloudWatchLogs) DeleteRetentionPolicyWithContext(ctx aws.Context, input *DeleteRetentionPolicyInput, opts ...request.Option) (*DeleteRetentionPolicyOutput, error)

DeleteRetentionPolicyWithContext is the same as DeleteRetentionPolicy with the addition of the ability to pass a context and additional request options.

See DeleteRetentionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DeleteSubscriptionFilter added in v0.6.1

func (c *CloudWatchLogs) DeleteSubscriptionFilter(input *DeleteSubscriptionFilterInput) (*DeleteSubscriptionFilterOutput, error)

DeleteSubscriptionFilter API operation for Amazon CloudWatch Logs.

Deletes the specified subscription filter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DeleteSubscriptionFilter for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteSubscriptionFilter

func (*CloudWatchLogs) DeleteSubscriptionFilterRequest added in v0.6.1

func (c *CloudWatchLogs) DeleteSubscriptionFilterRequest(input *DeleteSubscriptionFilterInput) (req *request.Request, output *DeleteSubscriptionFilterOutput)

DeleteSubscriptionFilterRequest generates a "aws/request.Request" representing the client's request for the DeleteSubscriptionFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSubscriptionFilter for more information on using the DeleteSubscriptionFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSubscriptionFilterRequest method.
req, resp := client.DeleteSubscriptionFilterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteSubscriptionFilter

func (*CloudWatchLogs) DeleteSubscriptionFilterWithContext added in v1.8.0

func (c *CloudWatchLogs) DeleteSubscriptionFilterWithContext(ctx aws.Context, input *DeleteSubscriptionFilterInput, opts ...request.Option) (*DeleteSubscriptionFilterOutput, error)

DeleteSubscriptionFilterWithContext is the same as DeleteSubscriptionFilter with the addition of the ability to pass a context and additional request options.

See DeleteSubscriptionFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeAccountPolicies added in v1.44.278

func (c *CloudWatchLogs) DescribeAccountPolicies(input *DescribeAccountPoliciesInput) (*DescribeAccountPoliciesOutput, error)

DescribeAccountPolicies API operation for Amazon CloudWatch Logs.

Returns a list of all CloudWatch Logs account policies in the account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeAccountPolicies for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeAccountPolicies

func (*CloudWatchLogs) DescribeAccountPoliciesRequest added in v1.44.278

func (c *CloudWatchLogs) DescribeAccountPoliciesRequest(input *DescribeAccountPoliciesInput) (req *request.Request, output *DescribeAccountPoliciesOutput)

DescribeAccountPoliciesRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountPolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccountPolicies for more information on using the DescribeAccountPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAccountPoliciesRequest method.
req, resp := client.DescribeAccountPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeAccountPolicies

func (*CloudWatchLogs) DescribeAccountPoliciesWithContext added in v1.44.278

func (c *CloudWatchLogs) DescribeAccountPoliciesWithContext(ctx aws.Context, input *DescribeAccountPoliciesInput, opts ...request.Option) (*DescribeAccountPoliciesOutput, error)

DescribeAccountPoliciesWithContext is the same as DescribeAccountPolicies with the addition of the ability to pass a context and additional request options.

See DescribeAccountPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeDeliveries added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliveries(input *DescribeDeliveriesInput) (*DescribeDeliveriesOutput, error)

DescribeDeliveries API operation for Amazon CloudWatch Logs.

Retrieves a list of the deliveries that have been created in the account.

A delivery is a connection between a delivery source (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) and a delivery destination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html).

A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery 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 in Enable logging from Amazon Web Services services. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeDeliveries for usage and error information.

Returned Error Types:

  • ServiceUnavailableException The service cannot complete the request.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ValidationException One of the parameters for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDeliveries

func (*CloudWatchLogs) DescribeDeliveriesPages added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliveriesPages(input *DescribeDeliveriesInput, fn func(*DescribeDeliveriesOutput, bool) bool) error

DescribeDeliveriesPages iterates over the pages of a DescribeDeliveries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDeliveries method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDeliveries operation.
pageNum := 0
err := client.DescribeDeliveriesPages(params,
    func(page *cloudwatchlogs.DescribeDeliveriesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) DescribeDeliveriesPagesWithContext added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliveriesPagesWithContext(ctx aws.Context, input *DescribeDeliveriesInput, fn func(*DescribeDeliveriesOutput, bool) bool, opts ...request.Option) error

DescribeDeliveriesPagesWithContext same as DescribeDeliveriesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeDeliveriesRequest added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliveriesRequest(input *DescribeDeliveriesInput) (req *request.Request, output *DescribeDeliveriesOutput)

DescribeDeliveriesRequest generates a "aws/request.Request" representing the client's request for the DescribeDeliveries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDeliveries for more information on using the DescribeDeliveries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDeliveriesRequest method.
req, resp := client.DescribeDeliveriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDeliveries

func (*CloudWatchLogs) DescribeDeliveriesWithContext added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliveriesWithContext(ctx aws.Context, input *DescribeDeliveriesInput, opts ...request.Option) (*DescribeDeliveriesOutput, error)

DescribeDeliveriesWithContext is the same as DescribeDeliveries with the addition of the ability to pass a context and additional request options.

See DescribeDeliveries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeDeliveryDestinations added in v1.47.8

DescribeDeliveryDestinations API operation for Amazon CloudWatch Logs.

Retrieves a list of the delivery destinations that have been created in the account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeDeliveryDestinations for usage and error information.

Returned Error Types:

  • ServiceUnavailableException The service cannot complete the request.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ValidationException One of the parameters for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDeliveryDestinations

func (*CloudWatchLogs) DescribeDeliveryDestinationsPages added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliveryDestinationsPages(input *DescribeDeliveryDestinationsInput, fn func(*DescribeDeliveryDestinationsOutput, bool) bool) error

DescribeDeliveryDestinationsPages iterates over the pages of a DescribeDeliveryDestinations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDeliveryDestinations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDeliveryDestinations operation.
pageNum := 0
err := client.DescribeDeliveryDestinationsPages(params,
    func(page *cloudwatchlogs.DescribeDeliveryDestinationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) DescribeDeliveryDestinationsPagesWithContext added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliveryDestinationsPagesWithContext(ctx aws.Context, input *DescribeDeliveryDestinationsInput, fn func(*DescribeDeliveryDestinationsOutput, bool) bool, opts ...request.Option) error

DescribeDeliveryDestinationsPagesWithContext same as DescribeDeliveryDestinationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeDeliveryDestinationsRequest added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliveryDestinationsRequest(input *DescribeDeliveryDestinationsInput) (req *request.Request, output *DescribeDeliveryDestinationsOutput)

DescribeDeliveryDestinationsRequest generates a "aws/request.Request" representing the client's request for the DescribeDeliveryDestinations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDeliveryDestinations for more information on using the DescribeDeliveryDestinations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDeliveryDestinationsRequest method.
req, resp := client.DescribeDeliveryDestinationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDeliveryDestinations

func (*CloudWatchLogs) DescribeDeliveryDestinationsWithContext added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliveryDestinationsWithContext(ctx aws.Context, input *DescribeDeliveryDestinationsInput, opts ...request.Option) (*DescribeDeliveryDestinationsOutput, error)

DescribeDeliveryDestinationsWithContext is the same as DescribeDeliveryDestinations with the addition of the ability to pass a context and additional request options.

See DescribeDeliveryDestinations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeDeliverySources added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliverySources(input *DescribeDeliverySourcesInput) (*DescribeDeliverySourcesOutput, error)

DescribeDeliverySources API operation for Amazon CloudWatch Logs.

Retrieves a list of the delivery sources that have been created in the account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeDeliverySources for usage and error information.

Returned Error Types:

  • ServiceUnavailableException The service cannot complete the request.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ValidationException One of the parameters for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDeliverySources

func (*CloudWatchLogs) DescribeDeliverySourcesPages added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliverySourcesPages(input *DescribeDeliverySourcesInput, fn func(*DescribeDeliverySourcesOutput, bool) bool) error

DescribeDeliverySourcesPages iterates over the pages of a DescribeDeliverySources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDeliverySources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDeliverySources operation.
pageNum := 0
err := client.DescribeDeliverySourcesPages(params,
    func(page *cloudwatchlogs.DescribeDeliverySourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) DescribeDeliverySourcesPagesWithContext added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliverySourcesPagesWithContext(ctx aws.Context, input *DescribeDeliverySourcesInput, fn func(*DescribeDeliverySourcesOutput, bool) bool, opts ...request.Option) error

DescribeDeliverySourcesPagesWithContext same as DescribeDeliverySourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeDeliverySourcesRequest added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliverySourcesRequest(input *DescribeDeliverySourcesInput) (req *request.Request, output *DescribeDeliverySourcesOutput)

DescribeDeliverySourcesRequest generates a "aws/request.Request" representing the client's request for the DescribeDeliverySources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDeliverySources for more information on using the DescribeDeliverySources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDeliverySourcesRequest method.
req, resp := client.DescribeDeliverySourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDeliverySources

func (*CloudWatchLogs) DescribeDeliverySourcesWithContext added in v1.47.8

func (c *CloudWatchLogs) DescribeDeliverySourcesWithContext(ctx aws.Context, input *DescribeDeliverySourcesInput, opts ...request.Option) (*DescribeDeliverySourcesOutput, error)

DescribeDeliverySourcesWithContext is the same as DescribeDeliverySources with the addition of the ability to pass a context and additional request options.

See DescribeDeliverySources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeDestinations added in v0.7.1

func (c *CloudWatchLogs) DescribeDestinations(input *DescribeDestinationsInput) (*DescribeDestinationsOutput, error)

DescribeDestinations API operation for Amazon CloudWatch Logs.

Lists all your destinations. The results are ASCII-sorted by destination name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeDestinations for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDestinations

func (*CloudWatchLogs) DescribeDestinationsPages added in v0.9.5

func (c *CloudWatchLogs) DescribeDestinationsPages(input *DescribeDestinationsInput, fn func(*DescribeDestinationsOutput, bool) bool) error

DescribeDestinationsPages iterates over the pages of a DescribeDestinations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDestinations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDestinations operation.
pageNum := 0
err := client.DescribeDestinationsPages(params,
    func(page *cloudwatchlogs.DescribeDestinationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) DescribeDestinationsPagesWithContext added in v1.8.0

func (c *CloudWatchLogs) DescribeDestinationsPagesWithContext(ctx aws.Context, input *DescribeDestinationsInput, fn func(*DescribeDestinationsOutput, bool) bool, opts ...request.Option) error

DescribeDestinationsPagesWithContext same as DescribeDestinationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeDestinationsRequest added in v0.7.1

func (c *CloudWatchLogs) DescribeDestinationsRequest(input *DescribeDestinationsInput) (req *request.Request, output *DescribeDestinationsOutput)

DescribeDestinationsRequest generates a "aws/request.Request" representing the client's request for the DescribeDestinations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDestinations for more information on using the DescribeDestinations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDestinationsRequest method.
req, resp := client.DescribeDestinationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDestinations

func (*CloudWatchLogs) DescribeDestinationsWithContext added in v1.8.0

func (c *CloudWatchLogs) DescribeDestinationsWithContext(ctx aws.Context, input *DescribeDestinationsInput, opts ...request.Option) (*DescribeDestinationsOutput, error)

DescribeDestinationsWithContext is the same as DescribeDestinations with the addition of the ability to pass a context and additional request options.

See DescribeDestinations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeExportTasks added in v0.9.9

func (c *CloudWatchLogs) DescribeExportTasks(input *DescribeExportTasksInput) (*DescribeExportTasksOutput, error)

DescribeExportTasks API operation for Amazon CloudWatch Logs.

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeExportTasks for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeExportTasks

func (*CloudWatchLogs) DescribeExportTasksRequest added in v0.9.9

func (c *CloudWatchLogs) DescribeExportTasksRequest(input *DescribeExportTasksInput) (req *request.Request, output *DescribeExportTasksOutput)

DescribeExportTasksRequest generates a "aws/request.Request" representing the client's request for the DescribeExportTasks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeExportTasks for more information on using the DescribeExportTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeExportTasksRequest method.
req, resp := client.DescribeExportTasksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeExportTasks

func (*CloudWatchLogs) DescribeExportTasksWithContext added in v1.8.0

func (c *CloudWatchLogs) DescribeExportTasksWithContext(ctx aws.Context, input *DescribeExportTasksInput, opts ...request.Option) (*DescribeExportTasksOutput, error)

DescribeExportTasksWithContext is the same as DescribeExportTasks with the addition of the ability to pass a context and additional request options.

See DescribeExportTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeLogGroups

func (c *CloudWatchLogs) DescribeLogGroups(input *DescribeLogGroupsInput) (*DescribeLogGroupsOutput, error)

DescribeLogGroups API operation for Amazon CloudWatch Logs.

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html).

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeLogGroups for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogGroups

func (*CloudWatchLogs) DescribeLogGroupsPages

func (c *CloudWatchLogs) DescribeLogGroupsPages(input *DescribeLogGroupsInput, fn func(*DescribeLogGroupsOutput, bool) bool) error

DescribeLogGroupsPages iterates over the pages of a DescribeLogGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeLogGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeLogGroups operation.
pageNum := 0
err := client.DescribeLogGroupsPages(params,
    func(page *cloudwatchlogs.DescribeLogGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) DescribeLogGroupsPagesWithContext added in v1.8.0

func (c *CloudWatchLogs) DescribeLogGroupsPagesWithContext(ctx aws.Context, input *DescribeLogGroupsInput, fn func(*DescribeLogGroupsOutput, bool) bool, opts ...request.Option) error

DescribeLogGroupsPagesWithContext same as DescribeLogGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeLogGroupsRequest

func (c *CloudWatchLogs) DescribeLogGroupsRequest(input *DescribeLogGroupsInput) (req *request.Request, output *DescribeLogGroupsOutput)

DescribeLogGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeLogGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLogGroups for more information on using the DescribeLogGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLogGroupsRequest method.
req, resp := client.DescribeLogGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogGroups

func (*CloudWatchLogs) DescribeLogGroupsWithContext added in v1.8.0

func (c *CloudWatchLogs) DescribeLogGroupsWithContext(ctx aws.Context, input *DescribeLogGroupsInput, opts ...request.Option) (*DescribeLogGroupsOutput, error)

DescribeLogGroupsWithContext is the same as DescribeLogGroups with the addition of the ability to pass a context and additional request options.

See DescribeLogGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeLogStreams

func (c *CloudWatchLogs) DescribeLogStreams(input *DescribeLogStreamsInput) (*DescribeLogStreamsOutput, error)

DescribeLogStreams API operation for Amazon CloudWatch Logs.

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

This operation has a limit of five transactions per second, after which transactions are throttled.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeLogStreams for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogStreams

func (*CloudWatchLogs) DescribeLogStreamsPages

func (c *CloudWatchLogs) DescribeLogStreamsPages(input *DescribeLogStreamsInput, fn func(*DescribeLogStreamsOutput, bool) bool) error

DescribeLogStreamsPages iterates over the pages of a DescribeLogStreams operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeLogStreams method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeLogStreams operation.
pageNum := 0
err := client.DescribeLogStreamsPages(params,
    func(page *cloudwatchlogs.DescribeLogStreamsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) DescribeLogStreamsPagesWithContext added in v1.8.0

func (c *CloudWatchLogs) DescribeLogStreamsPagesWithContext(ctx aws.Context, input *DescribeLogStreamsInput, fn func(*DescribeLogStreamsOutput, bool) bool, opts ...request.Option) error

DescribeLogStreamsPagesWithContext same as DescribeLogStreamsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeLogStreamsRequest

func (c *CloudWatchLogs) DescribeLogStreamsRequest(input *DescribeLogStreamsInput) (req *request.Request, output *DescribeLogStreamsOutput)

DescribeLogStreamsRequest generates a "aws/request.Request" representing the client's request for the DescribeLogStreams operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLogStreams for more information on using the DescribeLogStreams API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLogStreamsRequest method.
req, resp := client.DescribeLogStreamsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogStreams

func (*CloudWatchLogs) DescribeLogStreamsWithContext added in v1.8.0

func (c *CloudWatchLogs) DescribeLogStreamsWithContext(ctx aws.Context, input *DescribeLogStreamsInput, opts ...request.Option) (*DescribeLogStreamsOutput, error)

DescribeLogStreamsWithContext is the same as DescribeLogStreams with the addition of the ability to pass a context and additional request options.

See DescribeLogStreams for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeMetricFilters

func (c *CloudWatchLogs) DescribeMetricFilters(input *DescribeMetricFiltersInput) (*DescribeMetricFiltersOutput, error)

DescribeMetricFilters API operation for Amazon CloudWatch Logs.

Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeMetricFilters for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeMetricFilters

func (*CloudWatchLogs) DescribeMetricFiltersPages

func (c *CloudWatchLogs) DescribeMetricFiltersPages(input *DescribeMetricFiltersInput, fn func(*DescribeMetricFiltersOutput, bool) bool) error

DescribeMetricFiltersPages iterates over the pages of a DescribeMetricFilters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeMetricFilters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeMetricFilters operation.
pageNum := 0
err := client.DescribeMetricFiltersPages(params,
    func(page *cloudwatchlogs.DescribeMetricFiltersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) DescribeMetricFiltersPagesWithContext added in v1.8.0

func (c *CloudWatchLogs) DescribeMetricFiltersPagesWithContext(ctx aws.Context, input *DescribeMetricFiltersInput, fn func(*DescribeMetricFiltersOutput, bool) bool, opts ...request.Option) error

DescribeMetricFiltersPagesWithContext same as DescribeMetricFiltersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeMetricFiltersRequest

func (c *CloudWatchLogs) DescribeMetricFiltersRequest(input *DescribeMetricFiltersInput) (req *request.Request, output *DescribeMetricFiltersOutput)

DescribeMetricFiltersRequest generates a "aws/request.Request" representing the client's request for the DescribeMetricFilters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMetricFilters for more information on using the DescribeMetricFilters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeMetricFiltersRequest method.
req, resp := client.DescribeMetricFiltersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeMetricFilters

func (*CloudWatchLogs) DescribeMetricFiltersWithContext added in v1.8.0

func (c *CloudWatchLogs) DescribeMetricFiltersWithContext(ctx aws.Context, input *DescribeMetricFiltersInput, opts ...request.Option) (*DescribeMetricFiltersOutput, error)

DescribeMetricFiltersWithContext is the same as DescribeMetricFilters with the addition of the ability to pass a context and additional request options.

See DescribeMetricFilters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeQueries added in v1.15.84

func (c *CloudWatchLogs) DescribeQueries(input *DescribeQueriesInput) (*DescribeQueriesOutput, error)

DescribeQueries API operation for Amazon CloudWatch Logs.

Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeQueries for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueries

func (*CloudWatchLogs) DescribeQueriesRequest added in v1.15.84

func (c *CloudWatchLogs) DescribeQueriesRequest(input *DescribeQueriesInput) (req *request.Request, output *DescribeQueriesOutput)

DescribeQueriesRequest generates a "aws/request.Request" representing the client's request for the DescribeQueries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeQueries for more information on using the DescribeQueries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeQueriesRequest method.
req, resp := client.DescribeQueriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueries

func (*CloudWatchLogs) DescribeQueriesWithContext added in v1.15.84

func (c *CloudWatchLogs) DescribeQueriesWithContext(ctx aws.Context, input *DescribeQueriesInput, opts ...request.Option) (*DescribeQueriesOutput, error)

DescribeQueriesWithContext is the same as DescribeQueries with the addition of the ability to pass a context and additional request options.

See DescribeQueries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeQueryDefinitions added in v1.30.23

func (c *CloudWatchLogs) DescribeQueryDefinitions(input *DescribeQueryDefinitionsInput) (*DescribeQueryDefinitionsOutput, error)

DescribeQueryDefinitions API operation for Amazon CloudWatch Logs.

This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can retrieve query definitions from the current account or from a source account that is linked to the current account.

You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeQueryDefinitions for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueryDefinitions

func (*CloudWatchLogs) DescribeQueryDefinitionsRequest added in v1.30.23

func (c *CloudWatchLogs) DescribeQueryDefinitionsRequest(input *DescribeQueryDefinitionsInput) (req *request.Request, output *DescribeQueryDefinitionsOutput)

DescribeQueryDefinitionsRequest generates a "aws/request.Request" representing the client's request for the DescribeQueryDefinitions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeQueryDefinitions for more information on using the DescribeQueryDefinitions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeQueryDefinitionsRequest method.
req, resp := client.DescribeQueryDefinitionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueryDefinitions

func (*CloudWatchLogs) DescribeQueryDefinitionsWithContext added in v1.30.23

func (c *CloudWatchLogs) DescribeQueryDefinitionsWithContext(ctx aws.Context, input *DescribeQueryDefinitionsInput, opts ...request.Option) (*DescribeQueryDefinitionsOutput, error)

DescribeQueryDefinitionsWithContext is the same as DescribeQueryDefinitions with the addition of the ability to pass a context and additional request options.

See DescribeQueryDefinitions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeResourcePolicies added in v1.10.41

func (c *CloudWatchLogs) DescribeResourcePolicies(input *DescribeResourcePoliciesInput) (*DescribeResourcePoliciesOutput, error)

DescribeResourcePolicies API operation for Amazon CloudWatch Logs.

Lists the resource policies in this account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeResourcePolicies for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeResourcePolicies

func (*CloudWatchLogs) DescribeResourcePoliciesRequest added in v1.10.41

func (c *CloudWatchLogs) DescribeResourcePoliciesRequest(input *DescribeResourcePoliciesInput) (req *request.Request, output *DescribeResourcePoliciesOutput)

DescribeResourcePoliciesRequest generates a "aws/request.Request" representing the client's request for the DescribeResourcePolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeResourcePolicies for more information on using the DescribeResourcePolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeResourcePoliciesRequest method.
req, resp := client.DescribeResourcePoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeResourcePolicies

func (*CloudWatchLogs) DescribeResourcePoliciesWithContext added in v1.10.41

func (c *CloudWatchLogs) DescribeResourcePoliciesWithContext(ctx aws.Context, input *DescribeResourcePoliciesInput, opts ...request.Option) (*DescribeResourcePoliciesOutput, error)

DescribeResourcePoliciesWithContext is the same as DescribeResourcePolicies with the addition of the ability to pass a context and additional request options.

See DescribeResourcePolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeSubscriptionFilters added in v0.6.1

DescribeSubscriptionFilters API operation for Amazon CloudWatch Logs.

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DescribeSubscriptionFilters for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeSubscriptionFilters

func (*CloudWatchLogs) DescribeSubscriptionFiltersPages added in v0.9.5

func (c *CloudWatchLogs) DescribeSubscriptionFiltersPages(input *DescribeSubscriptionFiltersInput, fn func(*DescribeSubscriptionFiltersOutput, bool) bool) error

DescribeSubscriptionFiltersPages iterates over the pages of a DescribeSubscriptionFilters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeSubscriptionFilters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeSubscriptionFilters operation.
pageNum := 0
err := client.DescribeSubscriptionFiltersPages(params,
    func(page *cloudwatchlogs.DescribeSubscriptionFiltersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) DescribeSubscriptionFiltersPagesWithContext added in v1.8.0

func (c *CloudWatchLogs) DescribeSubscriptionFiltersPagesWithContext(ctx aws.Context, input *DescribeSubscriptionFiltersInput, fn func(*DescribeSubscriptionFiltersOutput, bool) bool, opts ...request.Option) error

DescribeSubscriptionFiltersPagesWithContext same as DescribeSubscriptionFiltersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DescribeSubscriptionFiltersRequest added in v0.6.1

func (c *CloudWatchLogs) DescribeSubscriptionFiltersRequest(input *DescribeSubscriptionFiltersInput) (req *request.Request, output *DescribeSubscriptionFiltersOutput)

DescribeSubscriptionFiltersRequest generates a "aws/request.Request" representing the client's request for the DescribeSubscriptionFilters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSubscriptionFilters for more information on using the DescribeSubscriptionFilters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSubscriptionFiltersRequest method.
req, resp := client.DescribeSubscriptionFiltersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeSubscriptionFilters

func (*CloudWatchLogs) DescribeSubscriptionFiltersWithContext added in v1.8.0

func (c *CloudWatchLogs) DescribeSubscriptionFiltersWithContext(ctx aws.Context, input *DescribeSubscriptionFiltersInput, opts ...request.Option) (*DescribeSubscriptionFiltersOutput, error)

DescribeSubscriptionFiltersWithContext is the same as DescribeSubscriptionFilters with the addition of the ability to pass a context and additional request options.

See DescribeSubscriptionFilters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) DisassociateKmsKey added in v1.10.50

func (c *CloudWatchLogs) DisassociateKmsKey(input *DisassociateKmsKeyInput) (*DisassociateKmsKeyOutput, error)

DisassociateKmsKey API operation for Amazon CloudWatch Logs.

Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.

When you use DisassociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.

  • Specify the logGroupName parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.

  • Specify the resourceIdentifier parameter with the query-result resource to stop using the KMS key to encrypt the results of all future StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html) operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.

It can take up to 5 minutes for this operation to take effect.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation DisassociateKmsKey for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DisassociateKmsKey

func (*CloudWatchLogs) DisassociateKmsKeyRequest added in v1.10.50

func (c *CloudWatchLogs) DisassociateKmsKeyRequest(input *DisassociateKmsKeyInput) (req *request.Request, output *DisassociateKmsKeyOutput)

DisassociateKmsKeyRequest generates a "aws/request.Request" representing the client's request for the DisassociateKmsKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateKmsKey for more information on using the DisassociateKmsKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateKmsKeyRequest method.
req, resp := client.DisassociateKmsKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DisassociateKmsKey

func (*CloudWatchLogs) DisassociateKmsKeyWithContext added in v1.10.50

func (c *CloudWatchLogs) DisassociateKmsKeyWithContext(ctx aws.Context, input *DisassociateKmsKeyInput, opts ...request.Option) (*DisassociateKmsKeyOutput, error)

DisassociateKmsKeyWithContext is the same as DisassociateKmsKey with the addition of the ability to pass a context and additional request options.

See DisassociateKmsKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) FilterLogEvents

func (c *CloudWatchLogs) FilterLogEvents(input *FilterLogEventsInput) (*FilterLogEventsOutput, error)

FilterLogEvents API operation for Amazon CloudWatch Logs.

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

You must have the logs:FilterLogEvents permission to perform this operation.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.

The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation FilterLogEvents for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/FilterLogEvents

func (*CloudWatchLogs) FilterLogEventsPages added in v0.9.5

func (c *CloudWatchLogs) FilterLogEventsPages(input *FilterLogEventsInput, fn func(*FilterLogEventsOutput, bool) bool) error

FilterLogEventsPages iterates over the pages of a FilterLogEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See FilterLogEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a FilterLogEvents operation.
pageNum := 0
err := client.FilterLogEventsPages(params,
    func(page *cloudwatchlogs.FilterLogEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) FilterLogEventsPagesWithContext added in v1.8.0

func (c *CloudWatchLogs) FilterLogEventsPagesWithContext(ctx aws.Context, input *FilterLogEventsInput, fn func(*FilterLogEventsOutput, bool) bool, opts ...request.Option) error

FilterLogEventsPagesWithContext same as FilterLogEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) FilterLogEventsRequest

func (c *CloudWatchLogs) FilterLogEventsRequest(input *FilterLogEventsInput) (req *request.Request, output *FilterLogEventsOutput)

FilterLogEventsRequest generates a "aws/request.Request" representing the client's request for the FilterLogEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See FilterLogEvents for more information on using the FilterLogEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the FilterLogEventsRequest method.
req, resp := client.FilterLogEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/FilterLogEvents

func (*CloudWatchLogs) FilterLogEventsWithContext added in v1.8.0

func (c *CloudWatchLogs) FilterLogEventsWithContext(ctx aws.Context, input *FilterLogEventsInput, opts ...request.Option) (*FilterLogEventsOutput, error)

FilterLogEventsWithContext is the same as FilterLogEvents with the addition of the ability to pass a context and additional request options.

See FilterLogEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) GetDataProtectionPolicy added in v1.44.146

func (c *CloudWatchLogs) GetDataProtectionPolicy(input *GetDataProtectionPolicyInput) (*GetDataProtectionPolicyOutput, error)

GetDataProtectionPolicy API operation for Amazon CloudWatch Logs.

Returns information about a log group data protection policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetDataProtectionPolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDataProtectionPolicy

func (*CloudWatchLogs) GetDataProtectionPolicyRequest added in v1.44.146

func (c *CloudWatchLogs) GetDataProtectionPolicyRequest(input *GetDataProtectionPolicyInput) (req *request.Request, output *GetDataProtectionPolicyOutput)

GetDataProtectionPolicyRequest generates a "aws/request.Request" representing the client's request for the GetDataProtectionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDataProtectionPolicy for more information on using the GetDataProtectionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDataProtectionPolicyRequest method.
req, resp := client.GetDataProtectionPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDataProtectionPolicy

func (*CloudWatchLogs) GetDataProtectionPolicyWithContext added in v1.44.146

func (c *CloudWatchLogs) GetDataProtectionPolicyWithContext(ctx aws.Context, input *GetDataProtectionPolicyInput, opts ...request.Option) (*GetDataProtectionPolicyOutput, error)

GetDataProtectionPolicyWithContext is the same as GetDataProtectionPolicy with the addition of the ability to pass a context and additional request options.

See GetDataProtectionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) GetDelivery added in v1.47.8

func (c *CloudWatchLogs) GetDelivery(input *GetDeliveryInput) (*GetDeliveryOutput, error)

GetDelivery API operation for Amazon CloudWatch Logs.

Returns complete information about one logical delivery. A delivery is a connection between a delivery source (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) and a delivery destination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html).

A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery 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 in Enable logging from Amazon Web Services services. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html)

You need to specify the delivery id in this operation. You can find the IDs of the deliveries in your account with the DescribeDeliveries (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html) operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetDelivery for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

  • ValidationException One of the parameters for the request is not valid.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ThrottlingException The request was throttled because of quota limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDelivery

func (*CloudWatchLogs) GetDeliveryDestination added in v1.47.8

func (c *CloudWatchLogs) GetDeliveryDestination(input *GetDeliveryDestinationInput) (*GetDeliveryDestinationOutput, error)

GetDeliveryDestination API operation for Amazon CloudWatch Logs.

Retrieves complete information about one delivery destination.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetDeliveryDestination for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

  • ValidationException One of the parameters for the request is not valid.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ThrottlingException The request was throttled because of quota limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliveryDestination

func (*CloudWatchLogs) GetDeliveryDestinationPolicy added in v1.47.8

GetDeliveryDestinationPolicy API operation for Amazon CloudWatch Logs.

Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetDeliveryDestinationPolicy for usage and error information.

Returned Error Types:

  • ServiceUnavailableException The service cannot complete the request.

  • ValidationException One of the parameters for the request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliveryDestinationPolicy

func (*CloudWatchLogs) GetDeliveryDestinationPolicyRequest added in v1.47.8

func (c *CloudWatchLogs) GetDeliveryDestinationPolicyRequest(input *GetDeliveryDestinationPolicyInput) (req *request.Request, output *GetDeliveryDestinationPolicyOutput)

GetDeliveryDestinationPolicyRequest generates a "aws/request.Request" representing the client's request for the GetDeliveryDestinationPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDeliveryDestinationPolicy for more information on using the GetDeliveryDestinationPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDeliveryDestinationPolicyRequest method.
req, resp := client.GetDeliveryDestinationPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliveryDestinationPolicy

func (*CloudWatchLogs) GetDeliveryDestinationPolicyWithContext added in v1.47.8

func (c *CloudWatchLogs) GetDeliveryDestinationPolicyWithContext(ctx aws.Context, input *GetDeliveryDestinationPolicyInput, opts ...request.Option) (*GetDeliveryDestinationPolicyOutput, error)

GetDeliveryDestinationPolicyWithContext is the same as GetDeliveryDestinationPolicy with the addition of the ability to pass a context and additional request options.

See GetDeliveryDestinationPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) GetDeliveryDestinationRequest added in v1.47.8

func (c *CloudWatchLogs) GetDeliveryDestinationRequest(input *GetDeliveryDestinationInput) (req *request.Request, output *GetDeliveryDestinationOutput)

GetDeliveryDestinationRequest generates a "aws/request.Request" representing the client's request for the GetDeliveryDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDeliveryDestination for more information on using the GetDeliveryDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDeliveryDestinationRequest method.
req, resp := client.GetDeliveryDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliveryDestination

func (*CloudWatchLogs) GetDeliveryDestinationWithContext added in v1.47.8

func (c *CloudWatchLogs) GetDeliveryDestinationWithContext(ctx aws.Context, input *GetDeliveryDestinationInput, opts ...request.Option) (*GetDeliveryDestinationOutput, error)

GetDeliveryDestinationWithContext is the same as GetDeliveryDestination with the addition of the ability to pass a context and additional request options.

See GetDeliveryDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) GetDeliveryRequest added in v1.47.8

func (c *CloudWatchLogs) GetDeliveryRequest(input *GetDeliveryInput) (req *request.Request, output *GetDeliveryOutput)

GetDeliveryRequest generates a "aws/request.Request" representing the client's request for the GetDelivery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDelivery for more information on using the GetDelivery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDeliveryRequest method.
req, resp := client.GetDeliveryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDelivery

func (*CloudWatchLogs) GetDeliverySource added in v1.47.8

func (c *CloudWatchLogs) GetDeliverySource(input *GetDeliverySourceInput) (*GetDeliverySourceOutput, error)

GetDeliverySource API operation for Amazon CloudWatch Logs.

Retrieves complete information about one delivery source.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetDeliverySource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

  • ValidationException One of the parameters for the request is not valid.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ThrottlingException The request was throttled because of quota limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliverySource

func (*CloudWatchLogs) GetDeliverySourceRequest added in v1.47.8

func (c *CloudWatchLogs) GetDeliverySourceRequest(input *GetDeliverySourceInput) (req *request.Request, output *GetDeliverySourceOutput)

GetDeliverySourceRequest generates a "aws/request.Request" representing the client's request for the GetDeliverySource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDeliverySource for more information on using the GetDeliverySource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDeliverySourceRequest method.
req, resp := client.GetDeliverySourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliverySource

func (*CloudWatchLogs) GetDeliverySourceWithContext added in v1.47.8

func (c *CloudWatchLogs) GetDeliverySourceWithContext(ctx aws.Context, input *GetDeliverySourceInput, opts ...request.Option) (*GetDeliverySourceOutput, error)

GetDeliverySourceWithContext is the same as GetDeliverySource with the addition of the ability to pass a context and additional request options.

See GetDeliverySource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) GetDeliveryWithContext added in v1.47.8

func (c *CloudWatchLogs) GetDeliveryWithContext(ctx aws.Context, input *GetDeliveryInput, opts ...request.Option) (*GetDeliveryOutput, error)

GetDeliveryWithContext is the same as GetDelivery with the addition of the ability to pass a context and additional request options.

See GetDelivery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) GetLogAnomalyDetector added in v1.48.4

func (c *CloudWatchLogs) GetLogAnomalyDetector(input *GetLogAnomalyDetectorInput) (*GetLogAnomalyDetectorOutput, error)

GetLogAnomalyDetector API operation for Amazon CloudWatch Logs.

Retrieves information about the log anomaly detector that you specify.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetLogAnomalyDetector for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogAnomalyDetector

func (*CloudWatchLogs) GetLogAnomalyDetectorRequest added in v1.48.4

func (c *CloudWatchLogs) GetLogAnomalyDetectorRequest(input *GetLogAnomalyDetectorInput) (req *request.Request, output *GetLogAnomalyDetectorOutput)

GetLogAnomalyDetectorRequest generates a "aws/request.Request" representing the client's request for the GetLogAnomalyDetector operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLogAnomalyDetector for more information on using the GetLogAnomalyDetector API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLogAnomalyDetectorRequest method.
req, resp := client.GetLogAnomalyDetectorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogAnomalyDetector

func (*CloudWatchLogs) GetLogAnomalyDetectorWithContext added in v1.48.4

func (c *CloudWatchLogs) GetLogAnomalyDetectorWithContext(ctx aws.Context, input *GetLogAnomalyDetectorInput, opts ...request.Option) (*GetLogAnomalyDetectorOutput, error)

GetLogAnomalyDetectorWithContext is the same as GetLogAnomalyDetector with the addition of the ability to pass a context and additional request options.

See GetLogAnomalyDetector for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) GetLogEvents

func (c *CloudWatchLogs) GetLogEvents(input *GetLogEventsInput) (*GetLogEventsOutput, error)

GetLogEvents API operation for Amazon CloudWatch Logs.

Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html).

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetLogEvents for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogEvents

func (*CloudWatchLogs) GetLogEventsPages

func (c *CloudWatchLogs) GetLogEventsPages(input *GetLogEventsInput, fn func(*GetLogEventsOutput, bool) bool) error

GetLogEventsPages iterates over the pages of a GetLogEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetLogEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetLogEvents operation.
pageNum := 0
err := client.GetLogEventsPages(params,
    func(page *cloudwatchlogs.GetLogEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) GetLogEventsPagesWithContext added in v1.8.0

func (c *CloudWatchLogs) GetLogEventsPagesWithContext(ctx aws.Context, input *GetLogEventsInput, fn func(*GetLogEventsOutput, bool) bool, opts ...request.Option) error

GetLogEventsPagesWithContext same as GetLogEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) GetLogEventsRequest

func (c *CloudWatchLogs) GetLogEventsRequest(input *GetLogEventsInput) (req *request.Request, output *GetLogEventsOutput)

GetLogEventsRequest generates a "aws/request.Request" representing the client's request for the GetLogEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLogEvents for more information on using the GetLogEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLogEventsRequest method.
req, resp := client.GetLogEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogEvents

func (*CloudWatchLogs) GetLogEventsWithContext added in v1.8.0

func (c *CloudWatchLogs) GetLogEventsWithContext(ctx aws.Context, input *GetLogEventsInput, opts ...request.Option) (*GetLogEventsOutput, error)

GetLogEventsWithContext is the same as GetLogEvents with the addition of the ability to pass a context and additional request options.

See GetLogEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) GetLogGroupFields added in v1.15.84

func (c *CloudWatchLogs) GetLogGroupFields(input *GetLogGroupFieldsInput) (*GetLogGroupFieldsOutput, error)

GetLogGroupFields API operation for Amazon CloudWatch Logs.

Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must specify one of these parameters, but you can't specify both.

In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html).

The response results are sorted by the frequency percentage, starting with the highest percentage.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetLogGroupFields for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogGroupFields

func (*CloudWatchLogs) GetLogGroupFieldsRequest added in v1.15.84

func (c *CloudWatchLogs) GetLogGroupFieldsRequest(input *GetLogGroupFieldsInput) (req *request.Request, output *GetLogGroupFieldsOutput)

GetLogGroupFieldsRequest generates a "aws/request.Request" representing the client's request for the GetLogGroupFields operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLogGroupFields for more information on using the GetLogGroupFields API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLogGroupFieldsRequest method.
req, resp := client.GetLogGroupFieldsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogGroupFields

func (*CloudWatchLogs) GetLogGroupFieldsWithContext added in v1.15.84

func (c *CloudWatchLogs) GetLogGroupFieldsWithContext(ctx aws.Context, input *GetLogGroupFieldsInput, opts ...request.Option) (*GetLogGroupFieldsOutput, error)

GetLogGroupFieldsWithContext is the same as GetLogGroupFields with the addition of the ability to pass a context and additional request options.

See GetLogGroupFields for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) GetLogRecord added in v1.15.84

func (c *CloudWatchLogs) GetLogRecord(input *GetLogRecordInput) (*GetLogRecordOutput, error)

GetLogRecord API operation for Amazon CloudWatch Logs.

Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.

The full unparsed log event is returned within @message.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetLogRecord for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogRecord

func (*CloudWatchLogs) GetLogRecordRequest added in v1.15.84

func (c *CloudWatchLogs) GetLogRecordRequest(input *GetLogRecordInput) (req *request.Request, output *GetLogRecordOutput)

GetLogRecordRequest generates a "aws/request.Request" representing the client's request for the GetLogRecord operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLogRecord for more information on using the GetLogRecord API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLogRecordRequest method.
req, resp := client.GetLogRecordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogRecord

func (*CloudWatchLogs) GetLogRecordWithContext added in v1.15.84

func (c *CloudWatchLogs) GetLogRecordWithContext(ctx aws.Context, input *GetLogRecordInput, opts ...request.Option) (*GetLogRecordOutput, error)

GetLogRecordWithContext is the same as GetLogRecord with the addition of the ability to pass a context and additional request options.

See GetLogRecord for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) GetQueryResults added in v1.15.84

func (c *CloudWatchLogs) GetQueryResults(input *GetQueryResultsInput) (*GetQueryResultsOutput, error)

GetQueryResults API operation for Amazon CloudWatch Logs.

Returns the results from the specified query.

Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogRecord.html) operation to get the full log record.

GetQueryResults does not start running a query. To run a query, use StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html). For more information about how long results of previous queries are available, see CloudWatch Logs quotas (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch_limits_cwl.html).

If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation GetQueryResults for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetQueryResults

func (*CloudWatchLogs) GetQueryResultsRequest added in v1.15.84

func (c *CloudWatchLogs) GetQueryResultsRequest(input *GetQueryResultsInput) (req *request.Request, output *GetQueryResultsOutput)

GetQueryResultsRequest generates a "aws/request.Request" representing the client's request for the GetQueryResults operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetQueryResults for more information on using the GetQueryResults API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetQueryResultsRequest method.
req, resp := client.GetQueryResultsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetQueryResults

func (*CloudWatchLogs) GetQueryResultsWithContext added in v1.15.84

func (c *CloudWatchLogs) GetQueryResultsWithContext(ctx aws.Context, input *GetQueryResultsInput, opts ...request.Option) (*GetQueryResultsOutput, error)

GetQueryResultsWithContext is the same as GetQueryResults with the addition of the ability to pass a context and additional request options.

See GetQueryResults for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) ListAnomalies added in v1.48.4

func (c *CloudWatchLogs) ListAnomalies(input *ListAnomaliesInput) (*ListAnomaliesOutput, error)

ListAnomalies API operation for Amazon CloudWatch Logs.

Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation ListAnomalies for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListAnomalies

func (*CloudWatchLogs) ListAnomaliesPages added in v1.48.4

func (c *CloudWatchLogs) ListAnomaliesPages(input *ListAnomaliesInput, fn func(*ListAnomaliesOutput, bool) bool) error

ListAnomaliesPages iterates over the pages of a ListAnomalies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAnomalies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAnomalies operation.
pageNum := 0
err := client.ListAnomaliesPages(params,
    func(page *cloudwatchlogs.ListAnomaliesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) ListAnomaliesPagesWithContext added in v1.48.4

func (c *CloudWatchLogs) ListAnomaliesPagesWithContext(ctx aws.Context, input *ListAnomaliesInput, fn func(*ListAnomaliesOutput, bool) bool, opts ...request.Option) error

ListAnomaliesPagesWithContext same as ListAnomaliesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) ListAnomaliesRequest added in v1.48.4

func (c *CloudWatchLogs) ListAnomaliesRequest(input *ListAnomaliesInput) (req *request.Request, output *ListAnomaliesOutput)

ListAnomaliesRequest generates a "aws/request.Request" representing the client's request for the ListAnomalies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAnomalies for more information on using the ListAnomalies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAnomaliesRequest method.
req, resp := client.ListAnomaliesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListAnomalies

func (*CloudWatchLogs) ListAnomaliesWithContext added in v1.48.4

func (c *CloudWatchLogs) ListAnomaliesWithContext(ctx aws.Context, input *ListAnomaliesInput, opts ...request.Option) (*ListAnomaliesOutput, error)

ListAnomaliesWithContext is the same as ListAnomalies with the addition of the ability to pass a context and additional request options.

See ListAnomalies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) ListLogAnomalyDetectors added in v1.48.4

func (c *CloudWatchLogs) ListLogAnomalyDetectors(input *ListLogAnomalyDetectorsInput) (*ListLogAnomalyDetectorsOutput, error)

ListLogAnomalyDetectors API operation for Amazon CloudWatch Logs.

Retrieves a list of the log anomaly detectors in the account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation ListLogAnomalyDetectors for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListLogAnomalyDetectors

func (*CloudWatchLogs) ListLogAnomalyDetectorsPages added in v1.48.4

func (c *CloudWatchLogs) ListLogAnomalyDetectorsPages(input *ListLogAnomalyDetectorsInput, fn func(*ListLogAnomalyDetectorsOutput, bool) bool) error

ListLogAnomalyDetectorsPages iterates over the pages of a ListLogAnomalyDetectors operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListLogAnomalyDetectors method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListLogAnomalyDetectors operation.
pageNum := 0
err := client.ListLogAnomalyDetectorsPages(params,
    func(page *cloudwatchlogs.ListLogAnomalyDetectorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchLogs) ListLogAnomalyDetectorsPagesWithContext added in v1.48.4

func (c *CloudWatchLogs) ListLogAnomalyDetectorsPagesWithContext(ctx aws.Context, input *ListLogAnomalyDetectorsInput, fn func(*ListLogAnomalyDetectorsOutput, bool) bool, opts ...request.Option) error

ListLogAnomalyDetectorsPagesWithContext same as ListLogAnomalyDetectorsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) ListLogAnomalyDetectorsRequest added in v1.48.4

func (c *CloudWatchLogs) ListLogAnomalyDetectorsRequest(input *ListLogAnomalyDetectorsInput) (req *request.Request, output *ListLogAnomalyDetectorsOutput)

ListLogAnomalyDetectorsRequest generates a "aws/request.Request" representing the client's request for the ListLogAnomalyDetectors operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListLogAnomalyDetectors for more information on using the ListLogAnomalyDetectors API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListLogAnomalyDetectorsRequest method.
req, resp := client.ListLogAnomalyDetectorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListLogAnomalyDetectors

func (*CloudWatchLogs) ListLogAnomalyDetectorsWithContext added in v1.48.4

func (c *CloudWatchLogs) ListLogAnomalyDetectorsWithContext(ctx aws.Context, input *ListLogAnomalyDetectorsInput, opts ...request.Option) (*ListLogAnomalyDetectorsOutput, error)

ListLogAnomalyDetectorsWithContext is the same as ListLogAnomalyDetectors with the addition of the ability to pass a context and additional request options.

See ListLogAnomalyDetectors for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) ListTagsForResource added in v1.44.127

func (c *CloudWatchLogs) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon CloudWatch Logs.

Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListTagsForResource

func (*CloudWatchLogs) ListTagsForResourceRequest added in v1.44.127

func (c *CloudWatchLogs) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListTagsForResource

func (*CloudWatchLogs) ListTagsForResourceWithContext added in v1.44.127

func (c *CloudWatchLogs) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) ListTagsLogGroup deprecated added in v1.6.3

func (c *CloudWatchLogs) ListTagsLogGroup(input *ListTagsLogGroupInput) (*ListTagsLogGroupOutput, error)

ListTagsLogGroup API operation for Amazon CloudWatch Logs.

The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html) instead.

Lists the tags for the specified log group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation ListTagsLogGroup for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListTagsLogGroup

Deprecated: Please use the generic tagging API ListTagsForResource

func (*CloudWatchLogs) ListTagsLogGroupRequest deprecated added in v1.6.3

func (c *CloudWatchLogs) ListTagsLogGroupRequest(input *ListTagsLogGroupInput) (req *request.Request, output *ListTagsLogGroupOutput)

ListTagsLogGroupRequest generates a "aws/request.Request" representing the client's request for the ListTagsLogGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsLogGroup for more information on using the ListTagsLogGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsLogGroupRequest method.
req, resp := client.ListTagsLogGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListTagsLogGroup

Deprecated: Please use the generic tagging API ListTagsForResource

func (*CloudWatchLogs) ListTagsLogGroupWithContext deprecated added in v1.8.0

func (c *CloudWatchLogs) ListTagsLogGroupWithContext(ctx aws.Context, input *ListTagsLogGroupInput, opts ...request.Option) (*ListTagsLogGroupOutput, error)

ListTagsLogGroupWithContext is the same as ListTagsLogGroup with the addition of the ability to pass a context and additional request options.

See ListTagsLogGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: Please use the generic tagging API ListTagsForResource

func (*CloudWatchLogs) PutAccountPolicy added in v1.44.278

func (c *CloudWatchLogs) PutAccountPolicy(input *PutAccountPolicyInput) (*PutAccountPolicyOutput, error)

PutAccountPolicy API operation for Amazon CloudWatch Logs.

Creates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.

Data protection policy

A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.

Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.

If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html) or FilterLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html) operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html).

To use the PutAccountPolicy operation for a data protection policy, you must be signed on with the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions.

The PutAccountPolicy operation applies to all log groups in the account. You can use PutDataProtectionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html) to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

Subscription filter policy

A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

The following destinations are supported for subscription filters:

  • An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.

  • An Firehose data stream in the same account as the subscription policy, for same-account delivery.

  • A Lambda function in the same account as the subscription policy, for same-account delivery.

  • A logical destination in a different account created with PutDestination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html), for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.

Each account can have one account-level subscription filter policy. If you are updating an existing filter, you must specify the correct name in PolicyName. To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutAccountPolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

  • ServiceUnavailableException The service cannot complete the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutAccountPolicy

func (*CloudWatchLogs) PutAccountPolicyRequest added in v1.44.278

func (c *CloudWatchLogs) PutAccountPolicyRequest(input *PutAccountPolicyInput) (req *request.Request, output *PutAccountPolicyOutput)

PutAccountPolicyRequest generates a "aws/request.Request" representing the client's request for the PutAccountPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutAccountPolicy for more information on using the PutAccountPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutAccountPolicyRequest method.
req, resp := client.PutAccountPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutAccountPolicy

func (*CloudWatchLogs) PutAccountPolicyWithContext added in v1.44.278

func (c *CloudWatchLogs) PutAccountPolicyWithContext(ctx aws.Context, input *PutAccountPolicyInput, opts ...request.Option) (*PutAccountPolicyOutput, error)

PutAccountPolicyWithContext is the same as PutAccountPolicy with the addition of the ability to pass a context and additional request options.

See PutAccountPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutDataProtectionPolicy added in v1.44.146

func (c *CloudWatchLogs) PutDataProtectionPolicy(input *PutDataProtectionPolicyInput) (*PutDataProtectionPolicyOutput, error)

PutDataProtectionPolicy API operation for Amazon CloudWatch Logs.

Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.

Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html) or FilterLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html) operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html).

The PutDataProtectionPolicy operation applies to only the specified log group. You can also use PutAccountPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html) to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutDataProtectionPolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

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

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDataProtectionPolicy

func (*CloudWatchLogs) PutDataProtectionPolicyRequest added in v1.44.146

func (c *CloudWatchLogs) PutDataProtectionPolicyRequest(input *PutDataProtectionPolicyInput) (req *request.Request, output *PutDataProtectionPolicyOutput)

PutDataProtectionPolicyRequest generates a "aws/request.Request" representing the client's request for the PutDataProtectionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDataProtectionPolicy for more information on using the PutDataProtectionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutDataProtectionPolicyRequest method.
req, resp := client.PutDataProtectionPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDataProtectionPolicy

func (*CloudWatchLogs) PutDataProtectionPolicyWithContext added in v1.44.146

func (c *CloudWatchLogs) PutDataProtectionPolicyWithContext(ctx aws.Context, input *PutDataProtectionPolicyInput, opts ...request.Option) (*PutDataProtectionPolicyOutput, error)

PutDataProtectionPolicyWithContext is the same as PutDataProtectionPolicy with the addition of the ability to pass a context and additional request options.

See PutDataProtectionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutDeliveryDestination added in v1.47.8

func (c *CloudWatchLogs) PutDeliveryDestination(input *PutDeliveryDestinationInput) (*PutDeliveryDestinationOutput, error)

PutDeliveryDestination API operation for Amazon CloudWatch Logs.

Creates or updates a logical delivery destination. 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, and Firehose are supported as logs delivery destinations.

To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:

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.

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. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html)

If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutDeliveryDestination for usage and error information.

Returned Error Types:

  • ServiceUnavailableException The service cannot complete the request.

  • ConflictException This operation attempted to create a resource that already exists.

  • ValidationException One of the parameters for the request is not valid.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ThrottlingException The request was throttled because of quota limits.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliveryDestination

func (*CloudWatchLogs) PutDeliveryDestinationPolicy added in v1.47.8

PutDeliveryDestinationPolicy API operation for Amazon CloudWatch Logs.

Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:

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. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html)

The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutDeliveryDestinationPolicy for usage and error information.

Returned Error Types:

  • ServiceUnavailableException The service cannot complete the request.

  • ValidationException One of the parameters for the request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ConflictException This operation attempted to create a resource that already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliveryDestinationPolicy

func (*CloudWatchLogs) PutDeliveryDestinationPolicyRequest added in v1.47.8

func (c *CloudWatchLogs) PutDeliveryDestinationPolicyRequest(input *PutDeliveryDestinationPolicyInput) (req *request.Request, output *PutDeliveryDestinationPolicyOutput)

PutDeliveryDestinationPolicyRequest generates a "aws/request.Request" representing the client's request for the PutDeliveryDestinationPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDeliveryDestinationPolicy for more information on using the PutDeliveryDestinationPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutDeliveryDestinationPolicyRequest method.
req, resp := client.PutDeliveryDestinationPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliveryDestinationPolicy

func (*CloudWatchLogs) PutDeliveryDestinationPolicyWithContext added in v1.47.8

func (c *CloudWatchLogs) PutDeliveryDestinationPolicyWithContext(ctx aws.Context, input *PutDeliveryDestinationPolicyInput, opts ...request.Option) (*PutDeliveryDestinationPolicyOutput, error)

PutDeliveryDestinationPolicyWithContext is the same as PutDeliveryDestinationPolicy with the addition of the ability to pass a context and additional request options.

See PutDeliveryDestinationPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutDeliveryDestinationRequest added in v1.47.8

func (c *CloudWatchLogs) PutDeliveryDestinationRequest(input *PutDeliveryDestinationInput) (req *request.Request, output *PutDeliveryDestinationOutput)

PutDeliveryDestinationRequest generates a "aws/request.Request" representing the client's request for the PutDeliveryDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDeliveryDestination for more information on using the PutDeliveryDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutDeliveryDestinationRequest method.
req, resp := client.PutDeliveryDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliveryDestination

func (*CloudWatchLogs) PutDeliveryDestinationWithContext added in v1.47.8

func (c *CloudWatchLogs) PutDeliveryDestinationWithContext(ctx aws.Context, input *PutDeliveryDestinationInput, opts ...request.Option) (*PutDeliveryDestinationOutput, error)

PutDeliveryDestinationWithContext is the same as PutDeliveryDestination with the addition of the ability to pass a context and additional request options.

See PutDeliveryDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutDeliverySource added in v1.47.8

func (c *CloudWatchLogs) PutDeliverySource(input *PutDeliverySourceInput) (*PutDeliverySourceOutput, error)

PutDeliverySource API operation for Amazon CloudWatch Logs.

Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.

To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:

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.

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. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html)

If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutDeliverySource for usage and error information.

Returned Error Types:

  • ServiceUnavailableException The service cannot complete the request.

  • ConflictException This operation attempted to create a resource that already exists.

  • ValidationException One of the parameters for the request is not valid.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The request was throttled because of quota limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliverySource

func (*CloudWatchLogs) PutDeliverySourceRequest added in v1.47.8

func (c *CloudWatchLogs) PutDeliverySourceRequest(input *PutDeliverySourceInput) (req *request.Request, output *PutDeliverySourceOutput)

PutDeliverySourceRequest generates a "aws/request.Request" representing the client's request for the PutDeliverySource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDeliverySource for more information on using the PutDeliverySource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutDeliverySourceRequest method.
req, resp := client.PutDeliverySourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliverySource

func (*CloudWatchLogs) PutDeliverySourceWithContext added in v1.47.8

func (c *CloudWatchLogs) PutDeliverySourceWithContext(ctx aws.Context, input *PutDeliverySourceInput, opts ...request.Option) (*PutDeliverySourceOutput, error)

PutDeliverySourceWithContext is the same as PutDeliverySource with the addition of the ability to pass a context and additional request options.

See PutDeliverySource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutDestination added in v0.7.1

func (c *CloudWatchLogs) PutDestination(input *PutDestinationInput) (*PutDestinationOutput, error)

PutDestination API operation for Amazon CloudWatch Logs.

Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html).

Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutSubscriptionFilter.html) against this destination. To enable this, the destination owner must call PutDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html) after PutDestination.

To perform a PutDestination operation, you must also have the iam:PassRole permission.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutDestination for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDestination

func (*CloudWatchLogs) PutDestinationPolicy added in v0.7.1

func (c *CloudWatchLogs) PutDestinationPolicy(input *PutDestinationPolicyInput) (*PutDestinationPolicyOutput, error)

PutDestinationPolicy API operation for Amazon CloudWatch Logs.

Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html) that is used to authorize claims to register a subscription filter against a given destination.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutDestinationPolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDestinationPolicy

func (*CloudWatchLogs) PutDestinationPolicyRequest added in v0.7.1

func (c *CloudWatchLogs) PutDestinationPolicyRequest(input *PutDestinationPolicyInput) (req *request.Request, output *PutDestinationPolicyOutput)

PutDestinationPolicyRequest generates a "aws/request.Request" representing the client's request for the PutDestinationPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDestinationPolicy for more information on using the PutDestinationPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutDestinationPolicyRequest method.
req, resp := client.PutDestinationPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDestinationPolicy

func (*CloudWatchLogs) PutDestinationPolicyWithContext added in v1.8.0

func (c *CloudWatchLogs) PutDestinationPolicyWithContext(ctx aws.Context, input *PutDestinationPolicyInput, opts ...request.Option) (*PutDestinationPolicyOutput, error)

PutDestinationPolicyWithContext is the same as PutDestinationPolicy with the addition of the ability to pass a context and additional request options.

See PutDestinationPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutDestinationRequest added in v0.7.1

func (c *CloudWatchLogs) PutDestinationRequest(input *PutDestinationInput) (req *request.Request, output *PutDestinationOutput)

PutDestinationRequest generates a "aws/request.Request" representing the client's request for the PutDestination operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDestination for more information on using the PutDestination API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutDestinationRequest method.
req, resp := client.PutDestinationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDestination

func (*CloudWatchLogs) PutDestinationWithContext added in v1.8.0

func (c *CloudWatchLogs) PutDestinationWithContext(ctx aws.Context, input *PutDestinationInput, opts ...request.Option) (*PutDestinationOutput, error)

PutDestinationWithContext is the same as PutDestination with the addition of the ability to pass a context and additional request options.

See PutDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutLogEvents

func (c *CloudWatchLogs) PutLogEvents(input *PutLogEventsInput) (*PutLogEventsOutput, error)

PutLogEvents API operation for Amazon CloudWatch Logs.

Uploads a batch of log events to the specified log stream.

The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

  • None of the log events in the batch can be more than 2 hours in the future.

  • None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.

  • The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

  • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

  • Each log event can be no larger than 256 KB.

  • The maximum number of log events in a batch is 10,000.

  • The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutLogEvents for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • InvalidSequenceTokenException 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.

  • DataAlreadyAcceptedException 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.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutLogEvents

func (*CloudWatchLogs) PutLogEventsRequest

func (c *CloudWatchLogs) PutLogEventsRequest(input *PutLogEventsInput) (req *request.Request, output *PutLogEventsOutput)

PutLogEventsRequest generates a "aws/request.Request" representing the client's request for the PutLogEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutLogEvents for more information on using the PutLogEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutLogEventsRequest method.
req, resp := client.PutLogEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutLogEvents

func (*CloudWatchLogs) PutLogEventsWithContext added in v1.8.0

func (c *CloudWatchLogs) PutLogEventsWithContext(ctx aws.Context, input *PutLogEventsInput, opts ...request.Option) (*PutLogEventsOutput, error)

PutLogEventsWithContext is the same as PutLogEvents with the addition of the ability to pass a context and additional request options.

See PutLogEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutMetricFilter

func (c *CloudWatchLogs) PutMetricFilter(input *PutMetricFilterInput) (*PutMetricFilterOutput, error)

PutMetricFilter API operation for Amazon CloudWatch Logs.

Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html).

The maximum number of metric filters that can be associated with a log group is 100.

When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.

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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutMetricFilter for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutMetricFilter

func (*CloudWatchLogs) PutMetricFilterRequest

func (c *CloudWatchLogs) PutMetricFilterRequest(input *PutMetricFilterInput) (req *request.Request, output *PutMetricFilterOutput)

PutMetricFilterRequest generates a "aws/request.Request" representing the client's request for the PutMetricFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutMetricFilter for more information on using the PutMetricFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutMetricFilterRequest method.
req, resp := client.PutMetricFilterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutMetricFilter

func (*CloudWatchLogs) PutMetricFilterWithContext added in v1.8.0

func (c *CloudWatchLogs) PutMetricFilterWithContext(ctx aws.Context, input *PutMetricFilterInput, opts ...request.Option) (*PutMetricFilterOutput, error)

PutMetricFilterWithContext is the same as PutMetricFilter with the addition of the ability to pass a context and additional request options.

See PutMetricFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutQueryDefinition added in v1.30.23

func (c *CloudWatchLogs) PutQueryDefinition(input *PutQueryDefinitionInput) (*PutQueryDefinitionOutput, error)

PutQueryDefinition API operation for Amazon CloudWatch Logs.

Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html).

To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups.

You must have the logs:PutQueryDefinition permission to be able to perform this operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutQueryDefinition for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutQueryDefinition

func (*CloudWatchLogs) PutQueryDefinitionRequest added in v1.30.23

func (c *CloudWatchLogs) PutQueryDefinitionRequest(input *PutQueryDefinitionInput) (req *request.Request, output *PutQueryDefinitionOutput)

PutQueryDefinitionRequest generates a "aws/request.Request" representing the client's request for the PutQueryDefinition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutQueryDefinition for more information on using the PutQueryDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutQueryDefinitionRequest method.
req, resp := client.PutQueryDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutQueryDefinition

func (*CloudWatchLogs) PutQueryDefinitionWithContext added in v1.30.23

func (c *CloudWatchLogs) PutQueryDefinitionWithContext(ctx aws.Context, input *PutQueryDefinitionInput, opts ...request.Option) (*PutQueryDefinitionOutput, error)

PutQueryDefinitionWithContext is the same as PutQueryDefinition with the addition of the ability to pass a context and additional request options.

See PutQueryDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutResourcePolicy added in v1.10.41

func (c *CloudWatchLogs) PutResourcePolicy(input *PutResourcePolicyInput) (*PutResourcePolicyOutput, error)

PutResourcePolicy API operation for Amazon CloudWatch Logs.

Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutResourcePolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutResourcePolicy

func (*CloudWatchLogs) PutResourcePolicyRequest added in v1.10.41

func (c *CloudWatchLogs) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req *request.Request, output *PutResourcePolicyOutput)

PutResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the PutResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutResourcePolicy for more information on using the PutResourcePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutResourcePolicyRequest method.
req, resp := client.PutResourcePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutResourcePolicy

func (*CloudWatchLogs) PutResourcePolicyWithContext added in v1.10.41

func (c *CloudWatchLogs) PutResourcePolicyWithContext(ctx aws.Context, input *PutResourcePolicyInput, opts ...request.Option) (*PutResourcePolicyOutput, error)

PutResourcePolicyWithContext is the same as PutResourcePolicy with the addition of the ability to pass a context and additional request options.

See PutResourcePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutRetentionPolicy

func (c *CloudWatchLogs) PutRetentionPolicy(input *PutRetentionPolicyInput) (*PutRetentionPolicyOutput, error)

PutRetentionPolicy API operation for Amazon CloudWatch Logs.

Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.

CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.

To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.

When log events reach their retention setting they are marked for deletion. After they are marked for deletion, they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These log events marked for deletion are also not included when you use an API to retrieve the storedBytes value to see how many bytes a log group is storing.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutRetentionPolicy for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutRetentionPolicy

func (*CloudWatchLogs) PutRetentionPolicyRequest

func (c *CloudWatchLogs) PutRetentionPolicyRequest(input *PutRetentionPolicyInput) (req *request.Request, output *PutRetentionPolicyOutput)

PutRetentionPolicyRequest generates a "aws/request.Request" representing the client's request for the PutRetentionPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutRetentionPolicy for more information on using the PutRetentionPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutRetentionPolicyRequest method.
req, resp := client.PutRetentionPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutRetentionPolicy

func (*CloudWatchLogs) PutRetentionPolicyWithContext added in v1.8.0

func (c *CloudWatchLogs) PutRetentionPolicyWithContext(ctx aws.Context, input *PutRetentionPolicyInput, opts ...request.Option) (*PutRetentionPolicyOutput, error)

PutRetentionPolicyWithContext is the same as PutRetentionPolicy with the addition of the ability to pass a context and additional request options.

See PutRetentionPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) PutSubscriptionFilter added in v0.6.1

func (c *CloudWatchLogs) PutSubscriptionFilter(input *PutSubscriptionFilterInput) (*PutSubscriptionFilterOutput, error)

PutSubscriptionFilter API operation for Amazon CloudWatch Logs.

Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html) and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

The following destinations are supported for subscription filters:

  • An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination created with PutDestination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html) that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.

  • An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

  • An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName.

To perform a PutSubscriptionFilter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation PutSubscriptionFilter for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

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

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutSubscriptionFilter

func (*CloudWatchLogs) PutSubscriptionFilterRequest added in v0.6.1

func (c *CloudWatchLogs) PutSubscriptionFilterRequest(input *PutSubscriptionFilterInput) (req *request.Request, output *PutSubscriptionFilterOutput)

PutSubscriptionFilterRequest generates a "aws/request.Request" representing the client's request for the PutSubscriptionFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutSubscriptionFilter for more information on using the PutSubscriptionFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutSubscriptionFilterRequest method.
req, resp := client.PutSubscriptionFilterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutSubscriptionFilter

func (*CloudWatchLogs) PutSubscriptionFilterWithContext added in v1.8.0

func (c *CloudWatchLogs) PutSubscriptionFilterWithContext(ctx aws.Context, input *PutSubscriptionFilterInput, opts ...request.Option) (*PutSubscriptionFilterOutput, error)

PutSubscriptionFilterWithContext is the same as PutSubscriptionFilter with the addition of the ability to pass a context and additional request options.

See PutSubscriptionFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) StartLiveTail added in v1.49.1

func (c *CloudWatchLogs) StartLiveTail(input *StartLiveTailInput) (*StartLiveTailOutput, error)

StartLiveTail API operation for Amazon CloudWatch Logs.

Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs_LiveTail.html).

The response to this operation is a response stream, over which the server sends live log events and the client receives them.

The following objects are sent over the stream:

You can end a session before it times out by closing the session stream or by closing the client that is receiving the stream. The session also ends if the established connection between the client and the server breaks.

For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/example_cloudwatch-logs_StartLiveTail_section.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation StartLiveTail for usage and error information.

Returned Error Types:

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

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

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

  • InvalidOperationException The operation is not valid on the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartLiveTail

func (*CloudWatchLogs) StartLiveTailRequest added in v1.49.1

func (c *CloudWatchLogs) StartLiveTailRequest(input *StartLiveTailInput) (req *request.Request, output *StartLiveTailOutput)

StartLiveTailRequest generates a "aws/request.Request" representing the client's request for the StartLiveTail operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartLiveTail for more information on using the StartLiveTail API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartLiveTailRequest method.
req, resp := client.StartLiveTailRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartLiveTail

func (*CloudWatchLogs) StartLiveTailWithContext added in v1.49.1

func (c *CloudWatchLogs) StartLiveTailWithContext(ctx aws.Context, input *StartLiveTailInput, opts ...request.Option) (*StartLiveTailOutput, error)

StartLiveTailWithContext is the same as StartLiveTail with the addition of the ability to pass a context and additional request options.

See StartLiveTail for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) StartQuery added in v1.15.84

func (c *CloudWatchLogs) StartQuery(input *StartQueryInput) (*StartQueryOutput, error)

StartQuery API operation for Amazon CloudWatch Logs.

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.

For more information, see CloudWatch Logs Insights Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).

After you run a query using StartQuery, the query results are stored by CloudWatch Logs. You can use GetQueryResults (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html) to retrieve the results of a query, using the queryId that StartQuery returns.

If you have associated a KMS key with the query results in this account, then StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html) uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.

Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html). For a cross-account StartQuery operation, the query definition must be defined in the monitoring account.

You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation StartQuery for usage and error information.

Returned Error Types:

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartQuery

func (*CloudWatchLogs) StartQueryRequest added in v1.15.84

func (c *CloudWatchLogs) StartQueryRequest(input *StartQueryInput) (req *request.Request, output *StartQueryOutput)

StartQueryRequest generates a "aws/request.Request" representing the client's request for the StartQuery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartQuery for more information on using the StartQuery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartQueryRequest method.
req, resp := client.StartQueryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartQuery

func (*CloudWatchLogs) StartQueryWithContext added in v1.15.84

func (c *CloudWatchLogs) StartQueryWithContext(ctx aws.Context, input *StartQueryInput, opts ...request.Option) (*StartQueryOutput, error)

StartQueryWithContext is the same as StartQuery with the addition of the ability to pass a context and additional request options.

See StartQuery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) StopQuery added in v1.15.84

func (c *CloudWatchLogs) StopQuery(input *StopQueryInput) (*StopQueryOutput, error)

StopQuery API operation for Amazon CloudWatch Logs.

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation StopQuery for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StopQuery

func (*CloudWatchLogs) StopQueryRequest added in v1.15.84

func (c *CloudWatchLogs) StopQueryRequest(input *StopQueryInput) (req *request.Request, output *StopQueryOutput)

StopQueryRequest generates a "aws/request.Request" representing the client's request for the StopQuery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopQuery for more information on using the StopQuery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopQueryRequest method.
req, resp := client.StopQueryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StopQuery

func (*CloudWatchLogs) StopQueryWithContext added in v1.15.84

func (c *CloudWatchLogs) StopQueryWithContext(ctx aws.Context, input *StopQueryInput, opts ...request.Option) (*StopQueryOutput, error)

StopQueryWithContext is the same as StopQuery with the addition of the ability to pass a context and additional request options.

See StopQuery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) TagLogGroup deprecated added in v1.6.3

func (c *CloudWatchLogs) TagLogGroup(input *TagLogGroupInput) (*TagLogGroupOutput, error)

TagLogGroup API operation for Amazon CloudWatch Logs.

The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html) instead.

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsForResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html). To remove tags, use UntagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html).

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#log-group-tagging) in the Amazon CloudWatch Logs User Guide.

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation TagLogGroup for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidParameterException A parameter is specified incorrectly.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TagLogGroup

Deprecated: Please use the generic tagging API TagResource

func (*CloudWatchLogs) TagLogGroupRequest deprecated added in v1.6.3

func (c *CloudWatchLogs) TagLogGroupRequest(input *TagLogGroupInput) (req *request.Request, output *TagLogGroupOutput)

TagLogGroupRequest generates a "aws/request.Request" representing the client's request for the TagLogGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagLogGroup for more information on using the TagLogGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagLogGroupRequest method.
req, resp := client.TagLogGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TagLogGroup

Deprecated: Please use the generic tagging API TagResource

func (*CloudWatchLogs) TagLogGroupWithContext deprecated added in v1.8.0

func (c *CloudWatchLogs) TagLogGroupWithContext(ctx aws.Context, input *TagLogGroupInput, opts ...request.Option) (*TagLogGroupOutput, error)

TagLogGroupWithContext is the same as TagLogGroup with the addition of the ability to pass a context and additional request options.

See TagLogGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: Please use the generic tagging API TagResource

func (*CloudWatchLogs) TagResource added in v1.44.127

func (c *CloudWatchLogs) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon CloudWatch Logs.

Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a CloudWatch Logs resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation TagResource for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

  • TooManyTagsException A resource can have no more than 50 tags.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TagResource

func (*CloudWatchLogs) TagResourceRequest added in v1.44.127

func (c *CloudWatchLogs) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TagResource

func (*CloudWatchLogs) TagResourceWithContext added in v1.44.127

func (c *CloudWatchLogs) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) TestMetricFilter

func (c *CloudWatchLogs) TestMetricFilter(input *TestMetricFilterInput) (*TestMetricFilterOutput, error)

TestMetricFilter API operation for Amazon CloudWatch Logs.

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation TestMetricFilter for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TestMetricFilter

func (*CloudWatchLogs) TestMetricFilterRequest

func (c *CloudWatchLogs) TestMetricFilterRequest(input *TestMetricFilterInput) (req *request.Request, output *TestMetricFilterOutput)

TestMetricFilterRequest generates a "aws/request.Request" representing the client's request for the TestMetricFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TestMetricFilter for more information on using the TestMetricFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TestMetricFilterRequest method.
req, resp := client.TestMetricFilterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TestMetricFilter

func (*CloudWatchLogs) TestMetricFilterWithContext added in v1.8.0

func (c *CloudWatchLogs) TestMetricFilterWithContext(ctx aws.Context, input *TestMetricFilterInput, opts ...request.Option) (*TestMetricFilterOutput, error)

TestMetricFilterWithContext is the same as TestMetricFilter with the addition of the ability to pass a context and additional request options.

See TestMetricFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) UntagLogGroup deprecated added in v1.6.3

func (c *CloudWatchLogs) UntagLogGroup(input *UntagLogGroupInput) (*UntagLogGroupOutput, error)

UntagLogGroup API operation for Amazon CloudWatch Logs.

The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html) instead.

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsForResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html). To add tags, use TagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html).

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation UntagLogGroup for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UntagLogGroup

Deprecated: Please use the generic tagging API UntagResource

func (*CloudWatchLogs) UntagLogGroupRequest deprecated added in v1.6.3

func (c *CloudWatchLogs) UntagLogGroupRequest(input *UntagLogGroupInput) (req *request.Request, output *UntagLogGroupOutput)

UntagLogGroupRequest generates a "aws/request.Request" representing the client's request for the UntagLogGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagLogGroup for more information on using the UntagLogGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagLogGroupRequest method.
req, resp := client.UntagLogGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UntagLogGroup

Deprecated: Please use the generic tagging API UntagResource

func (*CloudWatchLogs) UntagLogGroupWithContext deprecated added in v1.8.0

func (c *CloudWatchLogs) UntagLogGroupWithContext(ctx aws.Context, input *UntagLogGroupInput, opts ...request.Option) (*UntagLogGroupOutput, error)

UntagLogGroupWithContext is the same as UntagLogGroup with the addition of the ability to pass a context and additional request options.

See UntagLogGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: Please use the generic tagging API UntagResource

func (*CloudWatchLogs) UntagResource added in v1.44.127

func (c *CloudWatchLogs) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon CloudWatch Logs.

Removes one or more tags from the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation UntagResource for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UntagResource

func (*CloudWatchLogs) UntagResourceRequest added in v1.44.127

func (c *CloudWatchLogs) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UntagResource

func (*CloudWatchLogs) UntagResourceWithContext added in v1.44.127

func (c *CloudWatchLogs) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) UpdateAnomaly added in v1.48.4

func (c *CloudWatchLogs) UpdateAnomaly(input *UpdateAnomalyInput) (*UpdateAnomalyOutput, error)

UpdateAnomaly API operation for Amazon CloudWatch Logs.

Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won’t report new occurrences of that anomaly and won't update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won’t report any anomalies related to that pattern.

You must specify either anomalyId or patternId, but you can't specify both parameters in the same operation.

If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to stop suppressing, and omit the suppressionType and suppressionPeriod parameters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation UpdateAnomaly for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UpdateAnomaly

func (*CloudWatchLogs) UpdateAnomalyRequest added in v1.48.4

func (c *CloudWatchLogs) UpdateAnomalyRequest(input *UpdateAnomalyInput) (req *request.Request, output *UpdateAnomalyOutput)

UpdateAnomalyRequest generates a "aws/request.Request" representing the client's request for the UpdateAnomaly operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAnomaly for more information on using the UpdateAnomaly API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAnomalyRequest method.
req, resp := client.UpdateAnomalyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UpdateAnomaly

func (*CloudWatchLogs) UpdateAnomalyWithContext added in v1.48.4

func (c *CloudWatchLogs) UpdateAnomalyWithContext(ctx aws.Context, input *UpdateAnomalyInput, opts ...request.Option) (*UpdateAnomalyOutput, error)

UpdateAnomalyWithContext is the same as UpdateAnomaly with the addition of the ability to pass a context and additional request options.

See UpdateAnomaly for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchLogs) UpdateLogAnomalyDetector added in v1.48.4

func (c *CloudWatchLogs) UpdateLogAnomalyDetector(input *UpdateLogAnomalyDetectorInput) (*UpdateLogAnomalyDetectorOutput, error)

UpdateLogAnomalyDetector API operation for Amazon CloudWatch Logs.

Updates an existing log anomaly detector.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Logs's API operation UpdateLogAnomalyDetector for usage and error information.

Returned Error Types:

  • InvalidParameterException A parameter is specified incorrectly.

  • ResourceNotFoundException The specified resource does not exist.

  • ServiceUnavailableException The service cannot complete the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UpdateLogAnomalyDetector

func (*CloudWatchLogs) UpdateLogAnomalyDetectorRequest added in v1.48.4

func (c *CloudWatchLogs) UpdateLogAnomalyDetectorRequest(input *UpdateLogAnomalyDetectorInput) (req *request.Request, output *UpdateLogAnomalyDetectorOutput)

UpdateLogAnomalyDetectorRequest generates a "aws/request.Request" representing the client's request for the UpdateLogAnomalyDetector operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateLogAnomalyDetector for more information on using the UpdateLogAnomalyDetector API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateLogAnomalyDetectorRequest method.
req, resp := client.UpdateLogAnomalyDetectorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UpdateLogAnomalyDetector

func (*CloudWatchLogs) UpdateLogAnomalyDetectorWithContext added in v1.48.4

func (c *CloudWatchLogs) UpdateLogAnomalyDetectorWithContext(ctx aws.Context, input *UpdateLogAnomalyDetectorInput, opts ...request.Option) (*UpdateLogAnomalyDetectorOutput, error)

UpdateLogAnomalyDetectorWithContext is the same as UpdateLogAnomalyDetector with the addition of the ability to pass a context and additional request options.

See UpdateLogAnomalyDetector for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ConflictException added in v1.47.8

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This operation attempted to create a resource that already exists.

func (*ConflictException) Code added in v1.47.8

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.47.8

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.47.8

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.47.8

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.47.8

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.47.8

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.47.8

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.47.8

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDeliveryInput added in v1.47.8

type CreateDeliveryInput struct {

	// The ARN of the delivery destination to use for this delivery.
	//
	// DeliveryDestinationArn is a required field
	DeliveryDestinationArn *string `locationName:"deliveryDestinationArn" type:"string" required:"true"`

	// The name of the delivery source to use for this delivery.
	//
	// DeliverySourceName is a required field
	DeliverySourceName *string `locationName:"deliverySourceName" min:"1" type:"string" required:"true"`

	// An optional list of key-value pairs to associate with the resource.
	//
	// For more information about tagging, see Tagging Amazon Web Services resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateDeliveryInput) GoString added in v1.47.8

func (s CreateDeliveryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeliveryInput) SetDeliveryDestinationArn added in v1.47.8

func (s *CreateDeliveryInput) SetDeliveryDestinationArn(v string) *CreateDeliveryInput

SetDeliveryDestinationArn sets the DeliveryDestinationArn field's value.

func (*CreateDeliveryInput) SetDeliverySourceName added in v1.47.8

func (s *CreateDeliveryInput) SetDeliverySourceName(v string) *CreateDeliveryInput

SetDeliverySourceName sets the DeliverySourceName field's value.

func (*CreateDeliveryInput) SetTags added in v1.47.8

SetTags sets the Tags field's value.

func (CreateDeliveryInput) String added in v1.47.8

func (s CreateDeliveryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeliveryInput) Validate added in v1.47.8

func (s *CreateDeliveryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDeliveryOutput added in v1.47.8

type CreateDeliveryOutput struct {

	// A structure that contains information about the delivery that you just created.
	Delivery *Delivery `locationName:"delivery" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDeliveryOutput) GoString added in v1.47.8

func (s CreateDeliveryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDeliveryOutput) SetDelivery added in v1.47.8

SetDelivery sets the Delivery field's value.

func (CreateDeliveryOutput) String added in v1.47.8

func (s CreateDeliveryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateExportTaskInput added in v0.9.9

type CreateExportTaskInput struct {

	// The name of S3 bucket for the exported log data. The bucket must be in the
	// same Amazon Web Services Region.
	//
	// Destination is a required field
	Destination *string `locationName:"destination" min:"1" type:"string" required:"true"`

	// The prefix used as the start of the key for every object exported. If you
	// don't specify a value, the default is exportedlogs.
	DestinationPrefix *string `locationName:"destinationPrefix" type:"string"`

	// The start time of the range for the request, expressed as the number of milliseconds
	// after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this
	// time are not exported.
	//
	// From is a required field
	From *int64 `locationName:"from" type:"long" required:"true"`

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`

	// Export only log streams that match the provided prefix. If you don't specify
	// a value, no prefix filter is applied.
	LogStreamNamePrefix *string `locationName:"logStreamNamePrefix" min:"1" type:"string"`

	// The name of the export task.
	TaskName *string `locationName:"taskName" min:"1" type:"string"`

	// The end time of the range for the request, 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.
	//
	// You must specify a time that is not earlier than when this log group was
	// created.
	//
	// To is a required field
	To *int64 `locationName:"to" type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (CreateExportTaskInput) GoString added in v0.9.9

func (s CreateExportTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExportTaskInput) SetDestination added in v1.5.0

func (s *CreateExportTaskInput) SetDestination(v string) *CreateExportTaskInput

SetDestination sets the Destination field's value.

func (*CreateExportTaskInput) SetDestinationPrefix added in v1.5.0

func (s *CreateExportTaskInput) SetDestinationPrefix(v string) *CreateExportTaskInput

SetDestinationPrefix sets the DestinationPrefix field's value.

func (*CreateExportTaskInput) SetFrom added in v1.5.0

SetFrom sets the From field's value.

func (*CreateExportTaskInput) SetLogGroupName added in v1.5.0

func (s *CreateExportTaskInput) SetLogGroupName(v string) *CreateExportTaskInput

SetLogGroupName sets the LogGroupName field's value.

func (*CreateExportTaskInput) SetLogStreamNamePrefix added in v1.5.0

func (s *CreateExportTaskInput) SetLogStreamNamePrefix(v string) *CreateExportTaskInput

SetLogStreamNamePrefix sets the LogStreamNamePrefix field's value.

func (*CreateExportTaskInput) SetTaskName added in v1.5.0

SetTaskName sets the TaskName field's value.

func (*CreateExportTaskInput) SetTo added in v1.5.0

SetTo sets the To field's value.

func (CreateExportTaskInput) String added in v0.9.9

func (s CreateExportTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExportTaskInput) Validate added in v1.1.21

func (s *CreateExportTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateExportTaskOutput added in v0.9.9

type CreateExportTaskOutput struct {

	// The ID of the export task.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateExportTaskOutput) GoString added in v0.9.9

func (s CreateExportTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExportTaskOutput) SetTaskId added in v1.5.0

SetTaskId sets the TaskId field's value.

func (CreateExportTaskOutput) String added in v0.9.9

func (s CreateExportTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLogAnomalyDetectorInput added in v1.48.4

type CreateLogAnomalyDetectorInput struct {

	// The number of days to have visibility on an anomaly. After this time period
	// has elapsed for an anomaly, it will be automatically baselined and the anomaly
	// detector will treat new occurrences of a similar anomaly as normal. Therefore,
	// if you do not correct the cause of an anomaly during the time period specified
	// in anomalyVisibilityTime, it will be considered normal going forward and
	// will not be detected as an anomaly.
	AnomalyVisibilityTime *int64 `locationName:"anomalyVisibilityTime" min:"7" type:"long"`

	// A name for this anomaly detector.
	DetectorName *string `locationName:"detectorName" min:"1" type:"string"`

	// Specifies how often the anomaly detector is to run and look for anomalies.
	// Set this value according to the frequency that the log group receives new
	// logs. For example, if the log group receives new log events every 10 minutes,
	// then 15 minutes might be a good setting for evaluationFrequency .
	EvaluationFrequency *string `locationName:"evaluationFrequency" type:"string" enum:"EvaluationFrequency"`

	// You can use this parameter to limit the anomaly detection model to examine
	// only log events that match the pattern you specify here. For more information,
	// see Filter and Pattern Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
	FilterPattern *string `locationName:"filterPattern" type:"string"`

	// Optionally assigns a KMS key to secure this anomaly detector and its findings.
	// If a key is assigned, the anomalies found and the model used by this detector
	// are encrypted at rest with the key. If a key is assigned to an anomaly detector,
	// a user must have permissions for both this key and for the anomaly detector
	// to retrieve information about the anomalies that it finds.
	//
	// For more information about using a KMS key and to see the required IAM policy,
	// see Use a KMS key with an anomaly detector (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection-KMS.html).
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// An array containing the ARN of the log group that this anomaly detector will
	// watch. You can specify only one log group ARN.
	//
	// LogGroupArnList is a required field
	LogGroupArnList []*string `locationName:"logGroupArnList" type:"list" required:"true"`

	// An optional list of key-value pairs to associate with the resource.
	//
	// For more information about tagging, see Tagging Amazon Web Services resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateLogAnomalyDetectorInput) GoString added in v1.48.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLogAnomalyDetectorInput) SetAnomalyVisibilityTime added in v1.48.4

func (s *CreateLogAnomalyDetectorInput) SetAnomalyVisibilityTime(v int64) *CreateLogAnomalyDetectorInput

SetAnomalyVisibilityTime sets the AnomalyVisibilityTime field's value.

func (*CreateLogAnomalyDetectorInput) SetDetectorName added in v1.48.4

SetDetectorName sets the DetectorName field's value.

func (*CreateLogAnomalyDetectorInput) SetEvaluationFrequency added in v1.48.4

SetEvaluationFrequency sets the EvaluationFrequency field's value.

func (*CreateLogAnomalyDetectorInput) SetFilterPattern added in v1.48.4

SetFilterPattern sets the FilterPattern field's value.

func (*CreateLogAnomalyDetectorInput) SetKmsKeyId added in v1.48.4

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateLogAnomalyDetectorInput) SetLogGroupArnList added in v1.48.4

SetLogGroupArnList sets the LogGroupArnList field's value.

func (*CreateLogAnomalyDetectorInput) SetTags added in v1.48.4

SetTags sets the Tags field's value.

func (CreateLogAnomalyDetectorInput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLogAnomalyDetectorInput) Validate added in v1.48.4

func (s *CreateLogAnomalyDetectorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLogAnomalyDetectorOutput added in v1.48.4

type CreateLogAnomalyDetectorOutput struct {

	// The ARN of the log anomaly detector that you just created.
	AnomalyDetectorArn *string `locationName:"anomalyDetectorArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateLogAnomalyDetectorOutput) GoString added in v1.48.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLogAnomalyDetectorOutput) SetAnomalyDetectorArn added in v1.48.4

SetAnomalyDetectorArn sets the AnomalyDetectorArn field's value.

func (CreateLogAnomalyDetectorOutput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLogGroupInput

type CreateLogGroupInput struct {

	// The Amazon Resource Name (ARN) of the KMS key to use when encrypting log
	// data. For more information, see Amazon Resource Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms).
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// Use this parameter to specify 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.
	//
	// If you omit this parameter, the default of STANDARD is used.
	//
	// The value of logGroupClass can't be changed after a log group is created.
	//
	// For details about the features supported by each class, see Log classes (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)
	LogGroupClass *string `locationName:"logGroupClass" type:"string" enum:"LogGroupClass"`

	// A name for the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`

	// The key-value pairs to use for the tags.
	//
	// You can grant users access to certain log groups while preventing them from
	// accessing other log groups. To do so, tag your groups and use IAM policies
	// that refer to those tags. To assign tags when you create a log group, you
	// must have either the logs:TagResource or logs:TagLogGroup permission. For
	// more information about tagging, see Tagging Amazon Web Services resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For more
	// information about using tags to control access, see Controlling access to
	// Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html).
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateLogGroupInput) GoString added in v0.6.5

func (s CreateLogGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLogGroupInput) SetKmsKeyId added in v1.10.50

func (s *CreateLogGroupInput) SetKmsKeyId(v string) *CreateLogGroupInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateLogGroupInput) SetLogGroupClass added in v1.48.4

func (s *CreateLogGroupInput) SetLogGroupClass(v string) *CreateLogGroupInput

SetLogGroupClass sets the LogGroupClass field's value.

func (*CreateLogGroupInput) SetLogGroupName added in v1.5.0

func (s *CreateLogGroupInput) SetLogGroupName(v string) *CreateLogGroupInput

SetLogGroupName sets the LogGroupName field's value.

func (*CreateLogGroupInput) SetTags added in v1.6.3

SetTags sets the Tags field's value.

func (CreateLogGroupInput) String added in v0.6.5

func (s CreateLogGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLogGroupInput) Validate added in v1.1.21

func (s *CreateLogGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLogGroupOutput

type CreateLogGroupOutput struct {
	// contains filtered or unexported fields
}

func (CreateLogGroupOutput) GoString added in v0.6.5

func (s CreateLogGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateLogGroupOutput) String added in v0.6.5

func (s CreateLogGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLogStreamInput

type CreateLogStreamInput struct {

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`

	// The name of the log stream.
	//
	// LogStreamName is a required field
	LogStreamName *string `locationName:"logStreamName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateLogStreamInput) GoString added in v0.6.5

func (s CreateLogStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLogStreamInput) SetLogGroupName added in v1.5.0

func (s *CreateLogStreamInput) SetLogGroupName(v string) *CreateLogStreamInput

SetLogGroupName sets the LogGroupName field's value.

func (*CreateLogStreamInput) SetLogStreamName added in v1.5.0

func (s *CreateLogStreamInput) SetLogStreamName(v string) *CreateLogStreamInput

SetLogStreamName sets the LogStreamName field's value.

func (CreateLogStreamInput) String added in v0.6.5

func (s CreateLogStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLogStreamInput) Validate added in v1.1.21

func (s *CreateLogStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLogStreamOutput

type CreateLogStreamOutput struct {
	// contains filtered or unexported fields
}

func (CreateLogStreamOutput) GoString added in v0.6.5

func (s CreateLogStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateLogStreamOutput) String added in v0.6.5

func (s CreateLogStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataAlreadyAcceptedException added in v1.28.0

type DataAlreadyAcceptedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	ExpectedSequenceToken *string `locationName:"expectedSequenceToken" min:"1" type:"string"`

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0

Code returns the exception type name.

func (*DataAlreadyAcceptedException) Error added in v1.28.0

func (DataAlreadyAcceptedException) GoString added in v1.28.0

func (s DataAlreadyAcceptedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataAlreadyAcceptedException) Message added in v1.28.0

func (s *DataAlreadyAcceptedException) Message() string

Message returns the exception's message.

func (*DataAlreadyAcceptedException) OrigErr added in v1.28.0

func (s *DataAlreadyAcceptedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DataAlreadyAcceptedException) RequestID added in v1.28.0

func (s *DataAlreadyAcceptedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DataAlreadyAcceptedException) StatusCode added in v1.28.0

func (s *DataAlreadyAcceptedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DataAlreadyAcceptedException) String added in v1.28.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAccountPolicyInput added in v1.44.278

type DeleteAccountPolicyInput struct {

	// The name of the policy to delete.
	//
	// PolicyName is a required field
	PolicyName *string `locationName:"policyName" type:"string" required:"true"`

	// The type of policy to delete.
	//
	// PolicyType is a required field
	PolicyType *string `locationName:"policyType" type:"string" required:"true" enum:"PolicyType"`
	// contains filtered or unexported fields
}

func (DeleteAccountPolicyInput) GoString added in v1.44.278

func (s DeleteAccountPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccountPolicyInput) SetPolicyName added in v1.44.278

SetPolicyName sets the PolicyName field's value.

func (*DeleteAccountPolicyInput) SetPolicyType added in v1.44.278

SetPolicyType sets the PolicyType field's value.

func (DeleteAccountPolicyInput) String added in v1.44.278

func (s DeleteAccountPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccountPolicyInput) Validate added in v1.44.278

func (s *DeleteAccountPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAccountPolicyOutput added in v1.44.278

type DeleteAccountPolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteAccountPolicyOutput) GoString added in v1.44.278

func (s DeleteAccountPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAccountPolicyOutput) String added in v1.44.278

func (s DeleteAccountPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDataProtectionPolicyInput added in v1.44.146

type DeleteDataProtectionPolicyInput struct {

	// The name or ARN of the log group that you want to delete the data protection
	// policy for.
	//
	// LogGroupIdentifier is a required field
	LogGroupIdentifier *string `locationName:"logGroupIdentifier" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDataProtectionPolicyInput) GoString added in v1.44.146

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataProtectionPolicyInput) SetLogGroupIdentifier added in v1.44.146

SetLogGroupIdentifier sets the LogGroupIdentifier field's value.

func (DeleteDataProtectionPolicyInput) String added in v1.44.146

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataProtectionPolicyInput) Validate added in v1.44.146

func (s *DeleteDataProtectionPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDataProtectionPolicyOutput added in v1.44.146

type DeleteDataProtectionPolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDataProtectionPolicyOutput) GoString added in v1.44.146

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDataProtectionPolicyOutput) String added in v1.44.146

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDeliveryDestinationInput added in v1.47.8

type DeleteDeliveryDestinationInput struct {

	// The name of the delivery destination that you want to delete. You can find
	// a list of delivery destionation names by using the DescribeDeliveryDestinations
	// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveryDestinations.html)
	// operation.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDeliveryDestinationInput) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeliveryDestinationInput) SetName added in v1.47.8

SetName sets the Name field's value.

func (DeleteDeliveryDestinationInput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeliveryDestinationInput) Validate added in v1.47.8

func (s *DeleteDeliveryDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDeliveryDestinationOutput added in v1.47.8

type DeleteDeliveryDestinationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDeliveryDestinationOutput) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDeliveryDestinationOutput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDeliveryDestinationPolicyInput added in v1.47.8

type DeleteDeliveryDestinationPolicyInput struct {

	// The name of the delivery destination that you want to delete the policy for.
	//
	// DeliveryDestinationName is a required field
	DeliveryDestinationName *string `locationName:"deliveryDestinationName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDeliveryDestinationPolicyInput) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeliveryDestinationPolicyInput) SetDeliveryDestinationName added in v1.47.8

SetDeliveryDestinationName sets the DeliveryDestinationName field's value.

func (DeleteDeliveryDestinationPolicyInput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeliveryDestinationPolicyInput) Validate added in v1.47.8

Validate inspects the fields of the type to determine if they are valid.

type DeleteDeliveryDestinationPolicyOutput added in v1.47.8

type DeleteDeliveryDestinationPolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDeliveryDestinationPolicyOutput) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDeliveryDestinationPolicyOutput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDeliveryInput added in v1.47.8

type DeleteDeliveryInput struct {

	// The unique ID of the delivery to delete. You can find the ID of a delivery
	// with the DescribeDeliveries (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html)
	// operation.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDeliveryInput) GoString added in v1.47.8

func (s DeleteDeliveryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeliveryInput) SetId added in v1.47.8

SetId sets the Id field's value.

func (DeleteDeliveryInput) String added in v1.47.8

func (s DeleteDeliveryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeliveryInput) Validate added in v1.47.8

func (s *DeleteDeliveryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDeliveryOutput added in v1.47.8

type DeleteDeliveryOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDeliveryOutput) GoString added in v1.47.8

func (s DeleteDeliveryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDeliveryOutput) String added in v1.47.8

func (s DeleteDeliveryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDeliverySourceInput added in v1.47.8

type DeleteDeliverySourceInput struct {

	// The name of the delivery source that you want to delete.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDeliverySourceInput) GoString added in v1.47.8

func (s DeleteDeliverySourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeliverySourceInput) SetName added in v1.47.8

SetName sets the Name field's value.

func (DeleteDeliverySourceInput) String added in v1.47.8

func (s DeleteDeliverySourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDeliverySourceInput) Validate added in v1.47.8

func (s *DeleteDeliverySourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDeliverySourceOutput added in v1.47.8

type DeleteDeliverySourceOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDeliverySourceOutput) GoString added in v1.47.8

func (s DeleteDeliverySourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDeliverySourceOutput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDestinationInput added in v0.7.1

type DeleteDestinationInput struct {

	// The name of the destination.
	//
	// DestinationName is a required field
	DestinationName *string `locationName:"destinationName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDestinationInput) GoString added in v0.7.1

func (s DeleteDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDestinationInput) SetDestinationName added in v1.5.0

func (s *DeleteDestinationInput) SetDestinationName(v string) *DeleteDestinationInput

SetDestinationName sets the DestinationName field's value.

func (DeleteDestinationInput) String added in v0.7.1

func (s DeleteDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDestinationInput) Validate added in v1.1.21

func (s *DeleteDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDestinationOutput added in v0.7.1

type DeleteDestinationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDestinationOutput) GoString added in v0.7.1

func (s DeleteDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDestinationOutput) String added in v0.7.1

func (s DeleteDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteLogAnomalyDetectorInput added in v1.48.4

type DeleteLogAnomalyDetectorInput struct {

	// The ARN of the anomaly detector to delete. You can find the ARNs of log anomaly
	// detectors in your account by using the ListLogAnomalyDetectors (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html)
	// operation.
	//
	// AnomalyDetectorArn is a required field
	AnomalyDetectorArn *string `locationName:"anomalyDetectorArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLogAnomalyDetectorInput) GoString added in v1.48.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLogAnomalyDetectorInput) SetAnomalyDetectorArn added in v1.48.4

SetAnomalyDetectorArn sets the AnomalyDetectorArn field's value.

func (DeleteLogAnomalyDetectorInput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLogAnomalyDetectorInput) Validate added in v1.48.4

func (s *DeleteLogAnomalyDetectorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteLogAnomalyDetectorOutput added in v1.48.4

type DeleteLogAnomalyDetectorOutput struct {
	// contains filtered or unexported fields
}

func (DeleteLogAnomalyDetectorOutput) GoString added in v1.48.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLogAnomalyDetectorOutput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteLogGroupInput

type DeleteLogGroupInput struct {

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLogGroupInput) GoString added in v0.6.5

func (s DeleteLogGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLogGroupInput) SetLogGroupName added in v1.5.0

func (s *DeleteLogGroupInput) SetLogGroupName(v string) *DeleteLogGroupInput

SetLogGroupName sets the LogGroupName field's value.

func (DeleteLogGroupInput) String added in v0.6.5

func (s DeleteLogGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLogGroupInput) Validate added in v1.1.21

func (s *DeleteLogGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteLogGroupOutput

type DeleteLogGroupOutput struct {
	// contains filtered or unexported fields
}

func (DeleteLogGroupOutput) GoString added in v0.6.5

func (s DeleteLogGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLogGroupOutput) String added in v0.6.5

func (s DeleteLogGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteLogStreamInput

type DeleteLogStreamInput struct {

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`

	// The name of the log stream.
	//
	// LogStreamName is a required field
	LogStreamName *string `locationName:"logStreamName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLogStreamInput) GoString added in v0.6.5

func (s DeleteLogStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLogStreamInput) SetLogGroupName added in v1.5.0

func (s *DeleteLogStreamInput) SetLogGroupName(v string) *DeleteLogStreamInput

SetLogGroupName sets the LogGroupName field's value.

func (*DeleteLogStreamInput) SetLogStreamName added in v1.5.0

func (s *DeleteLogStreamInput) SetLogStreamName(v string) *DeleteLogStreamInput

SetLogStreamName sets the LogStreamName field's value.

func (DeleteLogStreamInput) String added in v0.6.5

func (s DeleteLogStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLogStreamInput) Validate added in v1.1.21

func (s *DeleteLogStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteLogStreamOutput

type DeleteLogStreamOutput struct {
	// contains filtered or unexported fields
}

func (DeleteLogStreamOutput) GoString added in v0.6.5

func (s DeleteLogStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLogStreamOutput) String added in v0.6.5

func (s DeleteLogStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteMetricFilterInput

type DeleteMetricFilterInput struct {

	// The name of the metric filter.
	//
	// FilterName is a required field
	FilterName *string `locationName:"filterName" min:"1" type:"string" required:"true"`

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMetricFilterInput) GoString added in v0.6.5

func (s DeleteMetricFilterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMetricFilterInput) SetFilterName added in v1.5.0

SetFilterName sets the FilterName field's value.

func (*DeleteMetricFilterInput) SetLogGroupName added in v1.5.0

SetLogGroupName sets the LogGroupName field's value.

func (DeleteMetricFilterInput) String added in v0.6.5

func (s DeleteMetricFilterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMetricFilterInput) Validate added in v1.1.21

func (s *DeleteMetricFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMetricFilterOutput

type DeleteMetricFilterOutput struct {
	// contains filtered or unexported fields
}

func (DeleteMetricFilterOutput) GoString added in v0.6.5

func (s DeleteMetricFilterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteMetricFilterOutput) String added in v0.6.5

func (s DeleteMetricFilterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteQueryDefinitionInput added in v1.30.23

type DeleteQueryDefinitionInput struct {

	// The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions
	// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html)
	// to retrieve the IDs of your saved query definitions.
	//
	// QueryDefinitionId is a required field
	QueryDefinitionId *string `locationName:"queryDefinitionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteQueryDefinitionInput) GoString added in v1.30.23

func (s DeleteQueryDefinitionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteQueryDefinitionInput) SetQueryDefinitionId added in v1.30.23

func (s *DeleteQueryDefinitionInput) SetQueryDefinitionId(v string) *DeleteQueryDefinitionInput

SetQueryDefinitionId sets the QueryDefinitionId field's value.

func (DeleteQueryDefinitionInput) String added in v1.30.23

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteQueryDefinitionInput) Validate added in v1.30.23

func (s *DeleteQueryDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteQueryDefinitionOutput added in v1.30.23

type DeleteQueryDefinitionOutput struct {

	// A value of TRUE indicates that the operation succeeded. FALSE indicates that
	// the operation failed.
	Success *bool `locationName:"success" type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteQueryDefinitionOutput) GoString added in v1.30.23

func (s DeleteQueryDefinitionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteQueryDefinitionOutput) SetSuccess added in v1.30.23

SetSuccess sets the Success field's value.

func (DeleteQueryDefinitionOutput) String added in v1.30.23

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteResourcePolicyInput added in v1.10.41

type DeleteResourcePolicyInput struct {

	// The name of the policy to be revoked. This parameter is required.
	PolicyName *string `locationName:"policyName" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteResourcePolicyInput) GoString added in v1.10.41

func (s DeleteResourcePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteResourcePolicyInput) SetPolicyName added in v1.10.41

SetPolicyName sets the PolicyName field's value.

func (DeleteResourcePolicyInput) String added in v1.10.41

func (s DeleteResourcePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteResourcePolicyOutput added in v1.10.41

type DeleteResourcePolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteResourcePolicyOutput) GoString added in v1.10.41

func (s DeleteResourcePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteResourcePolicyOutput) String added in v1.10.41

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteRetentionPolicyInput

type DeleteRetentionPolicyInput struct {

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRetentionPolicyInput) GoString added in v0.6.5

func (s DeleteRetentionPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRetentionPolicyInput) SetLogGroupName added in v1.5.0

SetLogGroupName sets the LogGroupName field's value.

func (DeleteRetentionPolicyInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRetentionPolicyInput) Validate added in v1.1.21

func (s *DeleteRetentionPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteRetentionPolicyOutput

type DeleteRetentionPolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteRetentionPolicyOutput) GoString added in v0.6.5

func (s DeleteRetentionPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteRetentionPolicyOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSubscriptionFilterInput added in v0.6.1

type DeleteSubscriptionFilterInput struct {

	// The name of the subscription filter.
	//
	// FilterName is a required field
	FilterName *string `locationName:"filterName" min:"1" type:"string" required:"true"`

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSubscriptionFilterInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSubscriptionFilterInput) SetFilterName added in v1.5.0

SetFilterName sets the FilterName field's value.

func (*DeleteSubscriptionFilterInput) SetLogGroupName added in v1.5.0

SetLogGroupName sets the LogGroupName field's value.

func (DeleteSubscriptionFilterInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSubscriptionFilterInput) Validate added in v1.1.21

func (s *DeleteSubscriptionFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSubscriptionFilterOutput added in v0.6.1

type DeleteSubscriptionFilterOutput struct {
	// contains filtered or unexported fields
}

func (DeleteSubscriptionFilterOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSubscriptionFilterOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Delivery added in v1.47.8

type Delivery struct {

	// The Amazon Resource Name (ARN) that uniquely identifies this delivery.
	Arn *string `locationName:"arn" type:"string"`

	// The ARN of the delivery destination that is associated with this delivery.
	DeliveryDestinationArn *string `locationName:"deliveryDestinationArn" type:"string"`

	// Displays whether the delivery destination associated with this delivery is
	// CloudWatch Logs, Amazon S3, or Firehose.
	DeliveryDestinationType *string `locationName:"deliveryDestinationType" type:"string" enum:"DeliveryDestinationType"`

	// The name of the delivery source that is associated with this delivery.
	DeliverySourceName *string `locationName:"deliverySourceName" min:"1" type:"string"`

	// The unique ID that identifies this delivery in your account.
	Id *string `locationName:"id" min:"1" type:"string"`

	// The tags that have been assigned to this delivery.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// 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 (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html).

You can't update an existing delivery. You can only create and delete deliveries.

func (Delivery) GoString added in v1.47.8

func (s Delivery) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Delivery) SetArn added in v1.47.8

func (s *Delivery) SetArn(v string) *Delivery

SetArn sets the Arn field's value.

func (*Delivery) SetDeliveryDestinationArn added in v1.47.8

func (s *Delivery) SetDeliveryDestinationArn(v string) *Delivery

SetDeliveryDestinationArn sets the DeliveryDestinationArn field's value.

func (*Delivery) SetDeliveryDestinationType added in v1.47.8

func (s *Delivery) SetDeliveryDestinationType(v string) *Delivery

SetDeliveryDestinationType sets the DeliveryDestinationType field's value.

func (*Delivery) SetDeliverySourceName added in v1.47.8

func (s *Delivery) SetDeliverySourceName(v string) *Delivery

SetDeliverySourceName sets the DeliverySourceName field's value.

func (*Delivery) SetId added in v1.47.8

func (s *Delivery) SetId(v string) *Delivery

SetId sets the Id field's value.

func (*Delivery) SetTags added in v1.47.8

func (s *Delivery) SetTags(v map[string]*string) *Delivery

SetTags sets the Tags field's value.

func (Delivery) String added in v1.47.8

func (s Delivery) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeliveryDestination added in v1.47.8

type DeliveryDestination struct {

	// The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
	Arn *string `locationName:"arn" type:"string"`

	// A structure that contains the ARN of the Amazon Web Services resource that
	// will receive the logs.
	DeliveryDestinationConfiguration *DeliveryDestinationConfiguration `locationName:"deliveryDestinationConfiguration" type:"structure"`

	// Displays whether this delivery destination is CloudWatch Logs, Amazon S3,
	// or Firehose.
	DeliveryDestinationType *string `locationName:"deliveryDestinationType" type:"string" enum:"DeliveryDestinationType"`

	// The name of this delivery destination.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The format of the logs that are sent to this delivery destination.
	OutputFormat *string `locationName:"outputFormat" type:"string" enum:"OutputFormat"`

	// The tags that have been assigned to this delivery destination.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// 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:

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.

func (DeliveryDestination) GoString added in v1.47.8

func (s DeliveryDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeliveryDestination) SetArn added in v1.47.8

SetArn sets the Arn field's value.

func (*DeliveryDestination) SetDeliveryDestinationConfiguration added in v1.47.8

func (s *DeliveryDestination) SetDeliveryDestinationConfiguration(v *DeliveryDestinationConfiguration) *DeliveryDestination

SetDeliveryDestinationConfiguration sets the DeliveryDestinationConfiguration field's value.

func (*DeliveryDestination) SetDeliveryDestinationType added in v1.47.8

func (s *DeliveryDestination) SetDeliveryDestinationType(v string) *DeliveryDestination

SetDeliveryDestinationType sets the DeliveryDestinationType field's value.

func (*DeliveryDestination) SetName added in v1.47.8

SetName sets the Name field's value.

func (*DeliveryDestination) SetOutputFormat added in v1.47.8

func (s *DeliveryDestination) SetOutputFormat(v string) *DeliveryDestination

SetOutputFormat sets the OutputFormat field's value.

func (*DeliveryDestination) SetTags added in v1.47.8

SetTags sets the Tags field's value.

func (DeliveryDestination) String added in v1.47.8

func (s DeliveryDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeliveryDestinationConfiguration added in v1.47.8

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.
	//
	// DestinationResourceArn is a required field
	DestinationResourceArn *string `locationName:"destinationResourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A structure that contains information about one logs delivery destination.

func (DeliveryDestinationConfiguration) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeliveryDestinationConfiguration) SetDestinationResourceArn added in v1.47.8

SetDestinationResourceArn sets the DestinationResourceArn field's value.

func (DeliveryDestinationConfiguration) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeliveryDestinationConfiguration) Validate added in v1.47.8

Validate inspects the fields of the type to determine if they are valid.

type DeliverySource added in v1.47.8

type DeliverySource struct {

	// The Amazon Resource Name (ARN) that uniquely identifies this delivery source.
	Arn *string `locationName:"arn" type:"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 `locationName:"logType" min:"1" type:"string"`

	// The unique name of the delivery source.
	Name *string `locationName:"name" min:"1" type:"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 `locationName:"resourceArns" type:"list"`

	// The Amazon Web Services service that is sending logs.
	Service *string `locationName:"service" min:"1" type:"string"`

	// The tags that have been assigned to this delivery source.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// 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. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html)

To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:

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.

func (DeliverySource) GoString added in v1.47.8

func (s DeliverySource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeliverySource) SetArn added in v1.47.8

func (s *DeliverySource) SetArn(v string) *DeliverySource

SetArn sets the Arn field's value.

func (*DeliverySource) SetLogType added in v1.47.8

func (s *DeliverySource) SetLogType(v string) *DeliverySource

SetLogType sets the LogType field's value.

func (*DeliverySource) SetName added in v1.47.8

func (s *DeliverySource) SetName(v string) *DeliverySource

SetName sets the Name field's value.

func (*DeliverySource) SetResourceArns added in v1.47.8

func (s *DeliverySource) SetResourceArns(v []*string) *DeliverySource

SetResourceArns sets the ResourceArns field's value.

func (*DeliverySource) SetService added in v1.47.8

func (s *DeliverySource) SetService(v string) *DeliverySource

SetService sets the Service field's value.

func (*DeliverySource) SetTags added in v1.47.8

func (s *DeliverySource) SetTags(v map[string]*string) *DeliverySource

SetTags sets the Tags field's value.

func (DeliverySource) String added in v1.47.8

func (s DeliverySource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountPoliciesInput added in v1.44.278

type DescribeAccountPoliciesInput struct {

	// If you are using an account that is set up as a monitoring account for CloudWatch
	// unified cross-account observability, you can use this to specify the account
	// ID of a source account. If you do, the operation returns the account policy
	// for the specified account. Currently, you can specify only one account ID
	// in this parameter.
	//
	// If you omit this parameter, only the policy in the current account is returned.
	AccountIdentifiers []*string `locationName:"accountIdentifiers" type:"list"`

	// Use this parameter to limit the returned policies to only the policy with
	// the name that you specify.
	PolicyName *string `locationName:"policyName" type:"string"`

	// Use this parameter to limit the returned policies to only the policies that
	// match the policy type that you specify.
	//
	// PolicyType is a required field
	PolicyType *string `locationName:"policyType" type:"string" required:"true" enum:"PolicyType"`
	// contains filtered or unexported fields
}

func (DescribeAccountPoliciesInput) GoString added in v1.44.278

func (s DescribeAccountPoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountPoliciesInput) SetAccountIdentifiers added in v1.44.278

func (s *DescribeAccountPoliciesInput) SetAccountIdentifiers(v []*string) *DescribeAccountPoliciesInput

SetAccountIdentifiers sets the AccountIdentifiers field's value.

func (*DescribeAccountPoliciesInput) SetPolicyName added in v1.44.278

SetPolicyName sets the PolicyName field's value.

func (*DescribeAccountPoliciesInput) SetPolicyType added in v1.44.278

SetPolicyType sets the PolicyType field's value.

func (DescribeAccountPoliciesInput) String added in v1.44.278

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountPoliciesInput) Validate added in v1.44.278

func (s *DescribeAccountPoliciesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAccountPoliciesOutput added in v1.44.278

type DescribeAccountPoliciesOutput struct {

	// An array of structures that contain information about the CloudWatch Logs
	// account policies that match the specified filters.
	AccountPolicies []*AccountPolicy `locationName:"accountPolicies" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeAccountPoliciesOutput) GoString added in v1.44.278

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountPoliciesOutput) SetAccountPolicies added in v1.44.278

SetAccountPolicies sets the AccountPolicies field's value.

func (DescribeAccountPoliciesOutput) String added in v1.44.278

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDeliveriesInput added in v1.47.8

type DescribeDeliveriesInput struct {

	// Optionally specify the maximum number of deliveries to return in the response.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDeliveriesInput) GoString added in v1.47.8

func (s DescribeDeliveriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDeliveriesInput) SetLimit added in v1.47.8

SetLimit sets the Limit field's value.

func (*DescribeDeliveriesInput) SetNextToken added in v1.47.8

SetNextToken sets the NextToken field's value.

func (DescribeDeliveriesInput) String added in v1.47.8

func (s DescribeDeliveriesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDeliveriesInput) Validate added in v1.47.8

func (s *DescribeDeliveriesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDeliveriesOutput added in v1.47.8

type DescribeDeliveriesOutput struct {

	// An array of structures. Each structure contains information about one delivery
	// in the account.
	Deliveries []*Delivery `locationName:"deliveries" type:"list"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDeliveriesOutput) GoString added in v1.47.8

func (s DescribeDeliveriesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDeliveriesOutput) SetDeliveries added in v1.47.8

SetDeliveries sets the Deliveries field's value.

func (*DescribeDeliveriesOutput) SetNextToken added in v1.47.8

SetNextToken sets the NextToken field's value.

func (DescribeDeliveriesOutput) String added in v1.47.8

func (s DescribeDeliveriesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDeliveryDestinationsInput added in v1.47.8

type DescribeDeliveryDestinationsInput struct {

	// Optionally specify the maximum number of delivery destinations to return
	// in the response.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDeliveryDestinationsInput) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDeliveryDestinationsInput) SetLimit added in v1.47.8

SetLimit sets the Limit field's value.

func (*DescribeDeliveryDestinationsInput) SetNextToken added in v1.47.8

SetNextToken sets the NextToken field's value.

func (DescribeDeliveryDestinationsInput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDeliveryDestinationsInput) Validate added in v1.47.8

Validate inspects the fields of the type to determine if they are valid.

type DescribeDeliveryDestinationsOutput added in v1.47.8

type DescribeDeliveryDestinationsOutput struct {

	// An array of structures. Each structure contains information about one delivery
	// destination in the account.
	DeliveryDestinations []*DeliveryDestination `locationName:"deliveryDestinations" type:"list"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDeliveryDestinationsOutput) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDeliveryDestinationsOutput) SetDeliveryDestinations added in v1.47.8

SetDeliveryDestinations sets the DeliveryDestinations field's value.

func (*DescribeDeliveryDestinationsOutput) SetNextToken added in v1.47.8

SetNextToken sets the NextToken field's value.

func (DescribeDeliveryDestinationsOutput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDeliverySourcesInput added in v1.47.8

type DescribeDeliverySourcesInput struct {

	// Optionally specify the maximum number of delivery sources to return in the
	// response.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDeliverySourcesInput) GoString added in v1.47.8

func (s DescribeDeliverySourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDeliverySourcesInput) SetLimit added in v1.47.8

SetLimit sets the Limit field's value.

func (*DescribeDeliverySourcesInput) SetNextToken added in v1.47.8

SetNextToken sets the NextToken field's value.

func (DescribeDeliverySourcesInput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDeliverySourcesInput) Validate added in v1.47.8

func (s *DescribeDeliverySourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDeliverySourcesOutput added in v1.47.8

type DescribeDeliverySourcesOutput struct {

	// An array of structures. Each structure contains information about one delivery
	// source in the account.
	DeliverySources []*DeliverySource `locationName:"deliverySources" type:"list"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDeliverySourcesOutput) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDeliverySourcesOutput) SetDeliverySources added in v1.47.8

SetDeliverySources sets the DeliverySources field's value.

func (*DescribeDeliverySourcesOutput) SetNextToken added in v1.47.8

SetNextToken sets the NextToken field's value.

func (DescribeDeliverySourcesOutput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDestinationsInput added in v0.7.1

type DescribeDestinationsInput struct {

	// The prefix to match. If you don't specify a value, no prefix filter is applied.
	DestinationNamePrefix *string `min:"1" type:"string"`

	// The maximum number of items returned. If you don't specify a value, the default
	// maximum value of 50 items is used.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDestinationsInput) GoString added in v0.7.1

func (s DescribeDestinationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDestinationsInput) SetDestinationNamePrefix added in v1.5.0

func (s *DescribeDestinationsInput) SetDestinationNamePrefix(v string) *DescribeDestinationsInput

SetDestinationNamePrefix sets the DestinationNamePrefix field's value.

func (*DescribeDestinationsInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeDestinationsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeDestinationsInput) String added in v0.7.1

func (s DescribeDestinationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDestinationsInput) Validate added in v1.1.21

func (s *DescribeDestinationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDestinationsOutput added in v0.7.1

type DescribeDestinationsOutput struct {

	// The destinations.
	Destinations []*Destination `locationName:"destinations" type:"list"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDestinationsOutput) GoString added in v0.7.1

func (s DescribeDestinationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDestinationsOutput) SetDestinations added in v1.5.0

SetDestinations sets the Destinations field's value.

func (*DescribeDestinationsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeDestinationsOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeExportTasksInput added in v0.9.9

type DescribeExportTasksInput struct {

	// The maximum number of items returned. If you don't specify a value, the default
	// is up to 50 items.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The status code of the export task. Specifying a status code filters the
	// results to zero or more export tasks.
	StatusCode *string `locationName:"statusCode" type:"string" enum:"ExportTaskStatusCode"`

	// The ID of the export task. Specifying a task ID filters the results to one
	// or zero export tasks.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeExportTasksInput) GoString added in v0.9.9

func (s DescribeExportTasksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExportTasksInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeExportTasksInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeExportTasksInput) SetStatusCode added in v1.5.0

SetStatusCode sets the StatusCode field's value.

func (*DescribeExportTasksInput) SetTaskId added in v1.5.0

SetTaskId sets the TaskId field's value.

func (DescribeExportTasksInput) String added in v0.9.9

func (s DescribeExportTasksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExportTasksInput) Validate added in v1.1.21

func (s *DescribeExportTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeExportTasksOutput added in v0.9.9

type DescribeExportTasksOutput struct {

	// The export tasks.
	ExportTasks []*ExportTask `locationName:"exportTasks" type:"list"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeExportTasksOutput) GoString added in v0.9.9

func (s DescribeExportTasksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExportTasksOutput) SetExportTasks added in v1.5.0

SetExportTasks sets the ExportTasks field's value.

func (*DescribeExportTasksOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeExportTasksOutput) String added in v0.9.9

func (s DescribeExportTasksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLogGroupsInput

type DescribeLogGroupsInput struct {

	// When includeLinkedAccounts is set to True, use this parameter to specify
	// the list of accounts to search. You can specify as many as 20 account IDs
	// in the array.
	AccountIdentifiers []*string `locationName:"accountIdentifiers" type:"list"`

	// If you are using a monitoring account, set this to True to have the operation
	// return log groups in the accounts listed in accountIdentifiers.
	//
	// If this parameter is set to true and accountIdentifiers contains a null value,
	// the operation returns all log groups in the monitoring account and all log
	// groups in all source accounts that are linked to the monitoring account.
	IncludeLinkedAccounts *bool `locationName:"includeLinkedAccounts" type:"boolean"`

	// The maximum number of items returned. If you don't specify a value, the default
	// is up to 50 items.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// 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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)
	LogGroupClass *string `locationName:"logGroupClass" type:"string" enum:"LogGroupClass"`

	// If you specify a string for this parameter, the operation returns only log
	// groups that have names that match the string based on a case-sensitive substring
	// search. For example, if you specify Foo, log groups named FooBar, aws/Foo,
	// and GroupFoo would match, but foo, F/o/o and Froo would not match.
	//
	// If you specify logGroupNamePattern in your request, then only arn, creationTime,
	// and logGroupName are included in the response.
	//
	// logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one
	// of these parameters can be passed.
	LogGroupNamePattern *string `locationName:"logGroupNamePattern" type:"string"`

	// The prefix to match.
	//
	// logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one
	// of these parameters can be passed.
	LogGroupNamePrefix *string `locationName:"logGroupNamePrefix" min:"1" type:"string"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLogGroupsInput) GoString added in v0.6.5

func (s DescribeLogGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLogGroupsInput) SetAccountIdentifiers added in v1.44.146

func (s *DescribeLogGroupsInput) SetAccountIdentifiers(v []*string) *DescribeLogGroupsInput

SetAccountIdentifiers sets the AccountIdentifiers field's value.

func (*DescribeLogGroupsInput) SetIncludeLinkedAccounts added in v1.44.146

func (s *DescribeLogGroupsInput) SetIncludeLinkedAccounts(v bool) *DescribeLogGroupsInput

SetIncludeLinkedAccounts sets the IncludeLinkedAccounts field's value.

func (*DescribeLogGroupsInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeLogGroupsInput) SetLogGroupClass added in v1.48.4

func (s *DescribeLogGroupsInput) SetLogGroupClass(v string) *DescribeLogGroupsInput

SetLogGroupClass sets the LogGroupClass field's value.

func (*DescribeLogGroupsInput) SetLogGroupNamePattern added in v1.44.146

func (s *DescribeLogGroupsInput) SetLogGroupNamePattern(v string) *DescribeLogGroupsInput

SetLogGroupNamePattern sets the LogGroupNamePattern field's value.

func (*DescribeLogGroupsInput) SetLogGroupNamePrefix added in v1.5.0

func (s *DescribeLogGroupsInput) SetLogGroupNamePrefix(v string) *DescribeLogGroupsInput

SetLogGroupNamePrefix sets the LogGroupNamePrefix field's value.

func (*DescribeLogGroupsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeLogGroupsInput) String added in v0.6.5

func (s DescribeLogGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLogGroupsInput) Validate added in v1.1.21

func (s *DescribeLogGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeLogGroupsOutput

type DescribeLogGroupsOutput struct {

	// The log groups.
	//
	// If the retentionInDays value is not included for a log group, then that log
	// group's events do not expire.
	LogGroups []*LogGroup `locationName:"logGroups" type:"list"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLogGroupsOutput) GoString added in v0.6.5

func (s DescribeLogGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLogGroupsOutput) SetLogGroups added in v1.5.0

SetLogGroups sets the LogGroups field's value.

func (*DescribeLogGroupsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeLogGroupsOutput) String added in v0.6.5

func (s DescribeLogGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLogStreamsInput

type DescribeLogStreamsInput struct {

	// If the value is true, results are returned in descending order. If the value
	// is to false, results are returned in ascending order. The default value is
	// false.
	Descending *bool `locationName:"descending" type:"boolean"`

	// The maximum number of items returned. If you don't specify a value, the default
	// is up to 50 items.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// Specify either the name or ARN of the log group to view. If the log group
	// is in a source account and you are using a monitoring account, you must use
	// the log group ARN.
	//
	// You must include either logGroupIdentifier or logGroupName, but not both.
	LogGroupIdentifier *string `locationName:"logGroupIdentifier" min:"1" type:"string"`

	// The name of the log group.
	//
	// You must include either logGroupIdentifier or logGroupName, but not both.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// The prefix to match.
	//
	// If orderBy is LastEventTime, you cannot specify this parameter.
	LogStreamNamePrefix *string `locationName:"logStreamNamePrefix" min:"1" type:"string"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// If the value is LogStreamName, the results are ordered by log stream name.
	// If the value is LastEventTime, the results are ordered by the event time.
	// The default value is LogStreamName.
	//
	// If you order the results by event time, you cannot specify the logStreamNamePrefix
	// parameter.
	//
	// lastEventTimestamp represents 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. lastEventTimestamp updates on
	// an eventual consistency basis. It typically updates in less than an hour
	// from ingestion, but in rare situations might take longer.
	OrderBy *string `locationName:"orderBy" type:"string" enum:"OrderBy"`
	// contains filtered or unexported fields
}

func (DescribeLogStreamsInput) GoString added in v0.6.5

func (s DescribeLogStreamsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLogStreamsInput) SetDescending added in v1.5.0

SetDescending sets the Descending field's value.

func (*DescribeLogStreamsInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeLogStreamsInput) SetLogGroupIdentifier added in v1.44.146

func (s *DescribeLogStreamsInput) SetLogGroupIdentifier(v string) *DescribeLogStreamsInput

SetLogGroupIdentifier sets the LogGroupIdentifier field's value.

func (*DescribeLogStreamsInput) SetLogGroupName added in v1.5.0

SetLogGroupName sets the LogGroupName field's value.

func (*DescribeLogStreamsInput) SetLogStreamNamePrefix added in v1.5.0

func (s *DescribeLogStreamsInput) SetLogStreamNamePrefix(v string) *DescribeLogStreamsInput

SetLogStreamNamePrefix sets the LogStreamNamePrefix field's value.

func (*DescribeLogStreamsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeLogStreamsInput) SetOrderBy added in v1.5.0

SetOrderBy sets the OrderBy field's value.

func (DescribeLogStreamsInput) String added in v0.6.5

func (s DescribeLogStreamsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLogStreamsInput) Validate added in v1.1.21

func (s *DescribeLogStreamsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeLogStreamsOutput

type DescribeLogStreamsOutput struct {

	// The log streams.
	LogStreams []*LogStream `locationName:"logStreams" type:"list"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLogStreamsOutput) GoString added in v0.6.5

func (s DescribeLogStreamsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLogStreamsOutput) SetLogStreams added in v1.5.0

SetLogStreams sets the LogStreams field's value.

func (*DescribeLogStreamsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeLogStreamsOutput) String added in v0.6.5

func (s DescribeLogStreamsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMetricFiltersInput

type DescribeMetricFiltersInput struct {

	// The prefix to match. CloudWatch Logs uses the value that you set here only
	// if you also include the logGroupName parameter in your request.
	FilterNamePrefix *string `locationName:"filterNamePrefix" min:"1" type:"string"`

	// The maximum number of items returned. If you don't specify a value, the default
	// is up to 50 items.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// The name of the log group.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// Filters results to include only those with the specified metric name. If
	// you include this parameter in your request, you must also include the metricNamespace
	// parameter.
	MetricName *string `locationName:"metricName" type:"string"`

	// Filters results to include only those in the specified namespace. If you
	// include this parameter in your request, you must also include the metricName
	// parameter.
	MetricNamespace *string `locationName:"metricNamespace" type:"string"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMetricFiltersInput) GoString added in v0.6.5

func (s DescribeMetricFiltersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMetricFiltersInput) SetFilterNamePrefix added in v1.5.0

SetFilterNamePrefix sets the FilterNamePrefix field's value.

func (*DescribeMetricFiltersInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeMetricFiltersInput) SetLogGroupName added in v1.5.0

SetLogGroupName sets the LogGroupName field's value.

func (*DescribeMetricFiltersInput) SetMetricName added in v1.5.3

SetMetricName sets the MetricName field's value.

func (*DescribeMetricFiltersInput) SetMetricNamespace added in v1.5.3

SetMetricNamespace sets the MetricNamespace field's value.

func (*DescribeMetricFiltersInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeMetricFiltersInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMetricFiltersInput) Validate added in v1.1.21

func (s *DescribeMetricFiltersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeMetricFiltersOutput

type DescribeMetricFiltersOutput struct {

	// The metric filters.
	MetricFilters []*MetricFilter `locationName:"metricFilters" type:"list"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMetricFiltersOutput) GoString added in v0.6.5

func (s DescribeMetricFiltersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMetricFiltersOutput) SetMetricFilters added in v1.5.0

SetMetricFilters sets the MetricFilters field's value.

func (*DescribeMetricFiltersOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeMetricFiltersOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeQueriesInput added in v1.15.84

type DescribeQueriesInput struct {

	// Limits the returned queries to only those for the specified log group.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// Limits the number of returned queries to the specified number.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Limits the returned queries to only those that have the specified status.
	// Valid values are Cancelled, Complete, Failed, Running, and Scheduled.
	Status *string `locationName:"status" type:"string" enum:"QueryStatus"`
	// contains filtered or unexported fields
}

func (DescribeQueriesInput) GoString added in v1.15.84

func (s DescribeQueriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQueriesInput) SetLogGroupName added in v1.15.84

func (s *DescribeQueriesInput) SetLogGroupName(v string) *DescribeQueriesInput

SetLogGroupName sets the LogGroupName field's value.

func (*DescribeQueriesInput) SetMaxResults added in v1.15.84

func (s *DescribeQueriesInput) SetMaxResults(v int64) *DescribeQueriesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeQueriesInput) SetNextToken added in v1.15.84

func (s *DescribeQueriesInput) SetNextToken(v string) *DescribeQueriesInput

SetNextToken sets the NextToken field's value.

func (*DescribeQueriesInput) SetStatus added in v1.15.84

SetStatus sets the Status field's value.

func (DescribeQueriesInput) String added in v1.15.84

func (s DescribeQueriesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQueriesInput) Validate added in v1.15.84

func (s *DescribeQueriesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeQueriesOutput added in v1.15.84

type DescribeQueriesOutput struct {

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The list of queries that match the request.
	Queries []*QueryInfo `locationName:"queries" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeQueriesOutput) GoString added in v1.15.84

func (s DescribeQueriesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQueriesOutput) SetNextToken added in v1.15.84

SetNextToken sets the NextToken field's value.

func (*DescribeQueriesOutput) SetQueries added in v1.15.84

SetQueries sets the Queries field's value.

func (DescribeQueriesOutput) String added in v1.15.84

func (s DescribeQueriesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeQueryDefinitionsInput added in v1.30.23

type DescribeQueryDefinitionsInput struct {

	// Limits the number of returned query definitions to the specified number.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Use this parameter to filter your results to only the query definitions that
	// have names that start with the prefix you specify.
	QueryDefinitionNamePrefix *string `locationName:"queryDefinitionNamePrefix" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeQueryDefinitionsInput) GoString added in v1.30.23

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQueryDefinitionsInput) SetMaxResults added in v1.30.23

SetMaxResults sets the MaxResults field's value.

func (*DescribeQueryDefinitionsInput) SetNextToken added in v1.30.23

SetNextToken sets the NextToken field's value.

func (*DescribeQueryDefinitionsInput) SetQueryDefinitionNamePrefix added in v1.30.23

func (s *DescribeQueryDefinitionsInput) SetQueryDefinitionNamePrefix(v string) *DescribeQueryDefinitionsInput

SetQueryDefinitionNamePrefix sets the QueryDefinitionNamePrefix field's value.

func (DescribeQueryDefinitionsInput) String added in v1.30.23

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQueryDefinitionsInput) Validate added in v1.30.23

func (s *DescribeQueryDefinitionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeQueryDefinitionsOutput added in v1.30.23

type DescribeQueryDefinitionsOutput struct {

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The list of query definitions that match your request.
	QueryDefinitions []*QueryDefinition `locationName:"queryDefinitions" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeQueryDefinitionsOutput) GoString added in v1.30.23

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQueryDefinitionsOutput) SetNextToken added in v1.30.23

SetNextToken sets the NextToken field's value.

func (*DescribeQueryDefinitionsOutput) SetQueryDefinitions added in v1.30.23

SetQueryDefinitions sets the QueryDefinitions field's value.

func (DescribeQueryDefinitionsOutput) String added in v1.30.23

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeResourcePoliciesInput added in v1.10.41

type DescribeResourcePoliciesInput struct {

	// The maximum number of resource policies to be displayed with one call of
	// this API.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeResourcePoliciesInput) GoString added in v1.10.41

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePoliciesInput) SetLimit added in v1.10.41

SetLimit sets the Limit field's value.

func (*DescribeResourcePoliciesInput) SetNextToken added in v1.10.41

SetNextToken sets the NextToken field's value.

func (DescribeResourcePoliciesInput) String added in v1.10.41

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePoliciesInput) Validate added in v1.10.41

func (s *DescribeResourcePoliciesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeResourcePoliciesOutput added in v1.10.41

type DescribeResourcePoliciesOutput struct {

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The resource policies that exist in this account.
	ResourcePolicies []*ResourcePolicy `locationName:"resourcePolicies" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeResourcePoliciesOutput) GoString added in v1.10.41

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePoliciesOutput) SetNextToken added in v1.10.41

SetNextToken sets the NextToken field's value.

func (*DescribeResourcePoliciesOutput) SetResourcePolicies added in v1.10.41

SetResourcePolicies sets the ResourcePolicies field's value.

func (DescribeResourcePoliciesOutput) String added in v1.10.41

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSubscriptionFiltersInput added in v0.6.1

type DescribeSubscriptionFiltersInput struct {

	// The prefix to match. If you don't specify a value, no prefix filter is applied.
	FilterNamePrefix *string `locationName:"filterNamePrefix" min:"1" type:"string"`

	// The maximum number of items returned. If you don't specify a value, the default
	// is up to 50 items.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeSubscriptionFiltersInput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSubscriptionFiltersInput) SetFilterNamePrefix added in v1.5.0

SetFilterNamePrefix sets the FilterNamePrefix field's value.

func (*DescribeSubscriptionFiltersInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*DescribeSubscriptionFiltersInput) SetLogGroupName added in v1.5.0

SetLogGroupName sets the LogGroupName field's value.

func (*DescribeSubscriptionFiltersInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeSubscriptionFiltersInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSubscriptionFiltersInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeSubscriptionFiltersOutput added in v0.6.1

type DescribeSubscriptionFiltersOutput struct {

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The subscription filters.
	SubscriptionFilters []*SubscriptionFilter `locationName:"subscriptionFilters" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeSubscriptionFiltersOutput) GoString added in v0.6.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSubscriptionFiltersOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*DescribeSubscriptionFiltersOutput) SetSubscriptionFilters added in v1.5.0

SetSubscriptionFilters sets the SubscriptionFilters field's value.

func (DescribeSubscriptionFiltersOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Destination added in v0.7.1

type Destination struct {

	// An IAM policy document that governs which Amazon Web Services accounts can
	// create subscription filters against this destination.
	AccessPolicy *string `locationName:"accessPolicy" min:"1" type:"string"`

	// The ARN of this destination.
	Arn *string `locationName:"arn" type:"string"`

	// The creation time of the destination, expressed as the number of milliseconds
	// after Jan 1, 1970 00:00:00 UTC.
	CreationTime *int64 `locationName:"creationTime" type:"long"`

	// The name of the destination.
	DestinationName *string `locationName:"destinationName" min:"1" type:"string"`

	// A role for impersonation, used when delivering log events to the target.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the physical target where the log events
	// are delivered (for example, a Kinesis stream).
	TargetArn *string `locationName:"targetArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (Destination) GoString added in v0.7.1

func (s Destination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Destination) SetAccessPolicy added in v1.5.0

func (s *Destination) SetAccessPolicy(v string) *Destination

SetAccessPolicy sets the AccessPolicy field's value.

func (*Destination) SetArn added in v1.5.0

func (s *Destination) SetArn(v string) *Destination

SetArn sets the Arn field's value.

func (*Destination) SetCreationTime added in v1.5.0

func (s *Destination) SetCreationTime(v int64) *Destination

SetCreationTime sets the CreationTime field's value.

func (*Destination) SetDestinationName added in v1.5.0

func (s *Destination) SetDestinationName(v string) *Destination

SetDestinationName sets the DestinationName field's value.

func (*Destination) SetRoleArn added in v1.5.0

func (s *Destination) SetRoleArn(v string) *Destination

SetRoleArn sets the RoleArn field's value.

func (*Destination) SetTargetArn added in v1.5.0

func (s *Destination) SetTargetArn(v string) *Destination

SetTargetArn sets the TargetArn field's value.

func (Destination) String added in v0.7.1

func (s Destination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateKmsKeyInput added in v1.10.50

type DisassociateKmsKeyInput struct {

	// The name of the log group.
	//
	// In your DisassociateKmsKey operation, you must specify either the resourceIdentifier
	// parameter or the logGroup parameter, but you can't specify both.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// Specifies the target for this operation. You must specify one of the following:
	//
	//    * Specify the ARN of a log group to stop having CloudWatch Logs use the
	//    KMS key to encrypt log events that are ingested and stored by that log
	//    group. After you run this operation, CloudWatch Logs encrypts ingested
	//    log events with the default CloudWatch Logs method. The log group ARN
	//    must be in the following format. Replace REGION and ACCOUNT_ID with your
	//    Region and account ID. arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME
	//
	//    * Specify the following ARN to stop using this key to encrypt the results
	//    of future StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html)
	//    operations in this account. Replace REGION and ACCOUNT_ID with your Region
	//    and account ID. arn:aws:logs:REGION:ACCOUNT_ID:query-result:*
	//
	// In your DisssociateKmsKey operation, you must specify either the resourceIdentifier
	// parameter or the logGroup parameter, but you can't specify both.
	ResourceIdentifier *string `locationName:"resourceIdentifier" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DisassociateKmsKeyInput) GoString added in v1.10.50

func (s DisassociateKmsKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateKmsKeyInput) SetLogGroupName added in v1.10.50

SetLogGroupName sets the LogGroupName field's value.

func (*DisassociateKmsKeyInput) SetResourceIdentifier added in v1.44.298

func (s *DisassociateKmsKeyInput) SetResourceIdentifier(v string) *DisassociateKmsKeyInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (DisassociateKmsKeyInput) String added in v1.10.50

func (s DisassociateKmsKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateKmsKeyInput) Validate added in v1.10.50

func (s *DisassociateKmsKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateKmsKeyOutput added in v1.10.50

type DisassociateKmsKeyOutput struct {
	// contains filtered or unexported fields
}

func (DisassociateKmsKeyOutput) GoString added in v1.10.50

func (s DisassociateKmsKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateKmsKeyOutput) String added in v1.10.50

func (s DisassociateKmsKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportTask added in v0.9.9

type ExportTask struct {

	// The name of the S3 bucket to which the log data was exported.
	Destination *string `locationName:"destination" min:"1" type:"string"`

	// The prefix that was used as the start of Amazon S3 key for every object exported.
	DestinationPrefix *string `locationName:"destinationPrefix" type:"string"`

	// Execution information about the export task.
	ExecutionInfo *ExportTaskExecutionInfo `locationName:"executionInfo" type:"structure"`

	// 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 `locationName:"from" type:"long"`

	// The name of the log group from which logs data was exported.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// The status of the export task.
	Status *ExportTaskStatus `locationName:"status" type:"structure"`

	// The ID of the export task.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`

	// The name of the export task.
	TaskName *string `locationName:"taskName" min:"1" type:"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 `locationName:"to" type:"long"`
	// contains filtered or unexported fields
}

Represents an export task.

func (ExportTask) GoString added in v0.9.9

func (s ExportTask) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportTask) SetDestination added in v1.5.0

func (s *ExportTask) SetDestination(v string) *ExportTask

SetDestination sets the Destination field's value.

func (*ExportTask) SetDestinationPrefix added in v1.5.0

func (s *ExportTask) SetDestinationPrefix(v string) *ExportTask

SetDestinationPrefix sets the DestinationPrefix field's value.

func (*ExportTask) SetExecutionInfo added in v1.5.0

func (s *ExportTask) SetExecutionInfo(v *ExportTaskExecutionInfo) *ExportTask

SetExecutionInfo sets the ExecutionInfo field's value.

func (*ExportTask) SetFrom added in v1.5.0

func (s *ExportTask) SetFrom(v int64) *ExportTask

SetFrom sets the From field's value.

func (*ExportTask) SetLogGroupName added in v1.5.0

func (s *ExportTask) SetLogGroupName(v string) *ExportTask

SetLogGroupName sets the LogGroupName field's value.

func (*ExportTask) SetStatus added in v1.5.0

func (s *ExportTask) SetStatus(v *ExportTaskStatus) *ExportTask

SetStatus sets the Status field's value.

func (*ExportTask) SetTaskId added in v1.5.0

func (s *ExportTask) SetTaskId(v string) *ExportTask

SetTaskId sets the TaskId field's value.

func (*ExportTask) SetTaskName added in v1.5.0

func (s *ExportTask) SetTaskName(v string) *ExportTask

SetTaskName sets the TaskName field's value.

func (*ExportTask) SetTo added in v1.5.0

func (s *ExportTask) SetTo(v int64) *ExportTask

SetTo sets the To field's value.

func (ExportTask) String added in v0.9.9

func (s ExportTask) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportTaskExecutionInfo added in v0.9.9

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 `locationName:"completionTime" type:"long"`

	// The creation time of the export task, expressed as the number of milliseconds
	// after Jan 1, 1970 00:00:00 UTC.
	CreationTime *int64 `locationName:"creationTime" type:"long"`
	// contains filtered or unexported fields
}

Represents the status of an export task.

func (ExportTaskExecutionInfo) GoString added in v0.9.9

func (s ExportTaskExecutionInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportTaskExecutionInfo) SetCompletionTime added in v1.5.0

func (s *ExportTaskExecutionInfo) SetCompletionTime(v int64) *ExportTaskExecutionInfo

SetCompletionTime sets the CompletionTime field's value.

func (*ExportTaskExecutionInfo) SetCreationTime added in v1.5.0

func (s *ExportTaskExecutionInfo) SetCreationTime(v int64) *ExportTaskExecutionInfo

SetCreationTime sets the CreationTime field's value.

func (ExportTaskExecutionInfo) String added in v0.9.9

func (s ExportTaskExecutionInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportTaskStatus added in v0.9.9

type ExportTaskStatus struct {

	// The status code of the export task.
	Code *string `locationName:"code" type:"string" enum:"ExportTaskStatusCode"`

	// The status message related to the status code.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Represents the status of an export task.

func (ExportTaskStatus) GoString added in v0.9.9

func (s ExportTaskStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportTaskStatus) SetCode added in v1.5.0

func (s *ExportTaskStatus) SetCode(v string) *ExportTaskStatus

SetCode sets the Code field's value.

func (*ExportTaskStatus) SetMessage added in v1.5.0

func (s *ExportTaskStatus) SetMessage(v string) *ExportTaskStatus

SetMessage sets the Message field's value.

func (ExportTaskStatus) String added in v0.9.9

func (s ExportTaskStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FilterLogEventsInput

type FilterLogEventsInput struct {

	// The end of the time range, expressed as the number of milliseconds after
	// Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are
	// not returned.
	EndTime *int64 `locationName:"endTime" type:"long"`

	// The filter pattern to use. For more information, see Filter and Pattern Syntax
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
	//
	// If not provided, all the events are matched.
	FilterPattern *string `locationName:"filterPattern" type:"string"`

	// If the value is true, the operation attempts to provide responses that contain
	// events from multiple log streams within the log group, interleaved in a single
	// response. If the value is false, all the matched log events in the first
	// log stream are searched first, then those in the next log stream, and so
	// on.
	//
	// Important As of June 17, 2019, this parameter is ignored and the value is
	// assumed to be true. The response from this operation always interleaves events
	// from multiple log streams within a log group.
	//
	// Deprecated: Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group.
	Interleaved *bool `locationName:"interleaved" deprecated:"true" type:"boolean"`

	// The maximum number of events to return. The default is 10,000 events.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// Specify either the name or ARN of the log group to view log events from.
	// If the log group is in a source account and you are using a monitoring account,
	// you must use the log group ARN.
	//
	// You must include either logGroupIdentifier or logGroupName, but not both.
	LogGroupIdentifier *string `locationName:"logGroupIdentifier" min:"1" type:"string"`

	// The name of the log group to search.
	//
	// You must include either logGroupIdentifier or logGroupName, but not both.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// Filters the results to include only events from log streams that have names
	// starting with this prefix.
	//
	// If you specify a value for both logStreamNamePrefix and logStreamNames, but
	// the value for logStreamNamePrefix does not match any log stream names specified
	// in logStreamNames, the action returns an InvalidParameterException error.
	LogStreamNamePrefix *string `locationName:"logStreamNamePrefix" min:"1" type:"string"`

	// Filters the results to only logs from the log streams in this list.
	//
	// If you specify a value for both logStreamNamePrefix and logStreamNames, the
	// action returns an InvalidParameterException error.
	LogStreamNames []*string `locationName:"logStreamNames" min:"1" type:"list"`

	// The token for the next set of events to return. (You received this token
	// from a previous call.)
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The start of the time range, expressed as the number of milliseconds after
	// Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not
	// returned.
	StartTime *int64 `locationName:"startTime" type:"long"`

	// Specify true to display the log event fields with all sensitive data unmasked
	// and visible. The default is false.
	//
	// To use this operation with this parameter, you must be signed into an account
	// with the logs:Unmask permission.
	Unmask *bool `locationName:"unmask" type:"boolean"`
	// contains filtered or unexported fields
}

func (FilterLogEventsInput) GoString added in v0.6.5

func (s FilterLogEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FilterLogEventsInput) SetEndTime added in v1.5.0

SetEndTime sets the EndTime field's value.

func (*FilterLogEventsInput) SetFilterPattern added in v1.5.0

func (s *FilterLogEventsInput) SetFilterPattern(v string) *FilterLogEventsInput

SetFilterPattern sets the FilterPattern field's value.

func (*FilterLogEventsInput) SetInterleaved added in v1.5.0

func (s *FilterLogEventsInput) SetInterleaved(v bool) *FilterLogEventsInput

SetInterleaved sets the Interleaved field's value.

func (*FilterLogEventsInput) SetLimit added in v1.5.0

SetLimit sets the Limit field's value.

func (*FilterLogEventsInput) SetLogGroupIdentifier added in v1.44.146

func (s *FilterLogEventsInput) SetLogGroupIdentifier(v string) *FilterLogEventsInput

SetLogGroupIdentifier sets the LogGroupIdentifier field's value.

func (*FilterLogEventsInput) SetLogGroupName added in v1.5.0

func (s *FilterLogEventsInput) SetLogGroupName(v string) *FilterLogEventsInput

SetLogGroupName sets the LogGroupName field's value.

func (*FilterLogEventsInput) SetLogStreamNamePrefix added in v1.15.31

func (s *FilterLogEventsInput) SetLogStreamNamePrefix(v string) *FilterLogEventsInput

SetLogStreamNamePrefix sets the LogStreamNamePrefix field's value.

func (*FilterLogEventsInput) SetLogStreamNames added in v1.5.0

func (s *FilterLogEventsInput) SetLogStreamNames(v []*string) *FilterLogEventsInput

SetLogStreamNames sets the LogStreamNames field's value.

func (*FilterLogEventsInput) SetNextToken added in v1.5.0

func (s *FilterLogEventsInput) SetNextToken(v string) *FilterLogEventsInput

SetNextToken sets the NextToken field's value.

func (*FilterLogEventsInput) SetStartTime added in v1.5.0

func (s *FilterLogEventsInput) SetStartTime(v int64) *FilterLogEventsInput

SetStartTime sets the StartTime field's value.

func (*FilterLogEventsInput) SetUnmask added in v1.44.146

SetUnmask sets the Unmask field's value.

func (FilterLogEventsInput) String added in v0.6.5

func (s FilterLogEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FilterLogEventsInput) Validate added in v1.1.21

func (s *FilterLogEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FilterLogEventsOutput

type FilterLogEventsOutput struct {

	// The matched events.
	Events []*FilteredLogEvent `locationName:"events" type:"list"`

	// The token to use when requesting the next set of items. The token expires
	// after 24 hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Important As of May 15, 2020, this parameter is no longer supported. This
	// parameter returns an empty list.
	//
	// Indicates which log streams have been searched and whether each has been
	// searched completely.
	SearchedLogStreams []*SearchedLogStream `locationName:"searchedLogStreams" type:"list"`
	// contains filtered or unexported fields
}

func (FilterLogEventsOutput) GoString added in v0.6.5

func (s FilterLogEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FilterLogEventsOutput) SetEvents added in v1.5.0

SetEvents sets the Events field's value.

func (*FilterLogEventsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (*FilterLogEventsOutput) SetSearchedLogStreams added in v1.5.0

func (s *FilterLogEventsOutput) SetSearchedLogStreams(v []*SearchedLogStream) *FilterLogEventsOutput

SetSearchedLogStreams sets the SearchedLogStreams field's value.

func (FilterLogEventsOutput) String added in v0.6.5

func (s FilterLogEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FilteredLogEvent

type FilteredLogEvent struct {

	// The ID of the event.
	EventId *string `locationName:"eventId" type:"string"`

	// The time the event was ingested, expressed as the number of milliseconds
	// after Jan 1, 1970 00:00:00 UTC.
	IngestionTime *int64 `locationName:"ingestionTime" type:"long"`

	// The name of the log stream to which this event belongs.
	LogStreamName *string `locationName:"logStreamName" min:"1" type:"string"`

	// The data contained in the log event.
	Message *string `locationName:"message" min:"1" type:"string"`

	// The time the event occurred, expressed as the number of milliseconds after
	// Jan 1, 1970 00:00:00 UTC.
	Timestamp *int64 `locationName:"timestamp" type:"long"`
	// contains filtered or unexported fields
}

Represents a matched event.

func (FilteredLogEvent) GoString added in v0.6.5

func (s FilteredLogEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FilteredLogEvent) SetEventId added in v1.5.0

func (s *FilteredLogEvent) SetEventId(v string) *FilteredLogEvent

SetEventId sets the EventId field's value.

func (*FilteredLogEvent) SetIngestionTime added in v1.5.0

func (s *FilteredLogEvent) SetIngestionTime(v int64) *FilteredLogEvent

SetIngestionTime sets the IngestionTime field's value.

func (*FilteredLogEvent) SetLogStreamName added in v1.5.0

func (s *FilteredLogEvent) SetLogStreamName(v string) *FilteredLogEvent

SetLogStreamName sets the LogStreamName field's value.

func (*FilteredLogEvent) SetMessage added in v1.5.0

func (s *FilteredLogEvent) SetMessage(v string) *FilteredLogEvent

SetMessage sets the Message field's value.

func (*FilteredLogEvent) SetTimestamp added in v1.5.0

func (s *FilteredLogEvent) SetTimestamp(v int64) *FilteredLogEvent

SetTimestamp sets the Timestamp field's value.

func (FilteredLogEvent) String added in v0.6.5

func (s FilteredLogEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDataProtectionPolicyInput added in v1.44.146

type GetDataProtectionPolicyInput struct {

	// The name or ARN of the log group that contains the data protection policy
	// that you want to see.
	//
	// LogGroupIdentifier is a required field
	LogGroupIdentifier *string `locationName:"logGroupIdentifier" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDataProtectionPolicyInput) GoString added in v1.44.146

func (s GetDataProtectionPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataProtectionPolicyInput) SetLogGroupIdentifier added in v1.44.146

SetLogGroupIdentifier sets the LogGroupIdentifier field's value.

func (GetDataProtectionPolicyInput) String added in v1.44.146

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataProtectionPolicyInput) Validate added in v1.44.146

func (s *GetDataProtectionPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDataProtectionPolicyOutput added in v1.44.146

type GetDataProtectionPolicyOutput struct {

	// The date and time that this policy was most recently updated.
	LastUpdatedTime *int64 `locationName:"lastUpdatedTime" type:"long"`

	// The log group name or ARN that you specified in your request.
	LogGroupIdentifier *string `locationName:"logGroupIdentifier" min:"1" type:"string"`

	// The data protection policy document for this log group.
	PolicyDocument *string `locationName:"policyDocument" type:"string"`
	// contains filtered or unexported fields
}

func (GetDataProtectionPolicyOutput) GoString added in v1.44.146

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataProtectionPolicyOutput) SetLastUpdatedTime added in v1.44.146

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*GetDataProtectionPolicyOutput) SetLogGroupIdentifier added in v1.44.146

SetLogGroupIdentifier sets the LogGroupIdentifier field's value.

func (*GetDataProtectionPolicyOutput) SetPolicyDocument added in v1.44.146

SetPolicyDocument sets the PolicyDocument field's value.

func (GetDataProtectionPolicyOutput) String added in v1.44.146

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDeliveryDestinationInput added in v1.47.8

type GetDeliveryDestinationInput struct {

	// The name of the delivery destination that you want to retrieve.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeliveryDestinationInput) GoString added in v1.47.8

func (s GetDeliveryDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliveryDestinationInput) SetName added in v1.47.8

SetName sets the Name field's value.

func (GetDeliveryDestinationInput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliveryDestinationInput) Validate added in v1.47.8

func (s *GetDeliveryDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDeliveryDestinationOutput added in v1.47.8

type GetDeliveryDestinationOutput struct {

	// A structure containing information about the delivery destination.
	DeliveryDestination *DeliveryDestination `locationName:"deliveryDestination" type:"structure"`
	// contains filtered or unexported fields
}

func (GetDeliveryDestinationOutput) GoString added in v1.47.8

func (s GetDeliveryDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliveryDestinationOutput) SetDeliveryDestination added in v1.47.8

SetDeliveryDestination sets the DeliveryDestination field's value.

func (GetDeliveryDestinationOutput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDeliveryDestinationPolicyInput added in v1.47.8

type GetDeliveryDestinationPolicyInput struct {

	// The name of the delivery destination that you want to retrieve the policy
	// of.
	//
	// DeliveryDestinationName is a required field
	DeliveryDestinationName *string `locationName:"deliveryDestinationName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeliveryDestinationPolicyInput) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliveryDestinationPolicyInput) SetDeliveryDestinationName added in v1.47.8

SetDeliveryDestinationName sets the DeliveryDestinationName field's value.

func (GetDeliveryDestinationPolicyInput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliveryDestinationPolicyInput) Validate added in v1.47.8

Validate inspects the fields of the type to determine if they are valid.

type GetDeliveryDestinationPolicyOutput added in v1.47.8

type GetDeliveryDestinationPolicyOutput struct {

	// The IAM policy for this delivery destination.
	Policy *Policy `locationName:"policy" type:"structure"`
	// contains filtered or unexported fields
}

func (GetDeliveryDestinationPolicyOutput) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliveryDestinationPolicyOutput) SetPolicy added in v1.47.8

SetPolicy sets the Policy field's value.

func (GetDeliveryDestinationPolicyOutput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDeliveryInput added in v1.47.8

type GetDeliveryInput struct {

	// The ID of the delivery that you want to retrieve.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeliveryInput) GoString added in v1.47.8

func (s GetDeliveryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliveryInput) SetId added in v1.47.8

SetId sets the Id field's value.

func (GetDeliveryInput) String added in v1.47.8

func (s GetDeliveryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliveryInput) Validate added in v1.47.8

func (s *GetDeliveryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDeliveryOutput added in v1.47.8

type GetDeliveryOutput struct {

	// A structure that contains information about the delivery.
	Delivery *Delivery `locationName:"delivery" type:"structure"`
	// contains filtered or unexported fields
}

func (GetDeliveryOutput) GoString added in v1.47.8

func (s GetDeliveryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliveryOutput) SetDelivery added in v1.47.8

func (s *GetDeliveryOutput) SetDelivery(v *Delivery) *GetDeliveryOutput

SetDelivery sets the Delivery field's value.

func (GetDeliveryOutput) String added in v1.47.8

func (s GetDeliveryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDeliverySourceInput added in v1.47.8

type GetDeliverySourceInput struct {

	// The name of the delivery source that you want to retrieve.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeliverySourceInput) GoString added in v1.47.8

func (s GetDeliverySourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliverySourceInput) SetName added in v1.47.8

SetName sets the Name field's value.

func (GetDeliverySourceInput) String added in v1.47.8

func (s GetDeliverySourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliverySourceInput) Validate added in v1.47.8

func (s *GetDeliverySourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDeliverySourceOutput added in v1.47.8

type GetDeliverySourceOutput struct {

	// A structure containing information about the delivery source.
	DeliverySource *DeliverySource `locationName:"deliverySource" type:"structure"`
	// contains filtered or unexported fields
}

func (GetDeliverySourceOutput) GoString added in v1.47.8

func (s GetDeliverySourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDeliverySourceOutput) SetDeliverySource added in v1.47.8

SetDeliverySource sets the DeliverySource field's value.

func (GetDeliverySourceOutput) String added in v1.47.8

func (s GetDeliverySourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLogAnomalyDetectorInput added in v1.48.4

type GetLogAnomalyDetectorInput struct {

	// The ARN of the anomaly detector to retrieve information about. You can find
	// the ARNs of log anomaly detectors in your account by using the ListLogAnomalyDetectors
	// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html)
	// operation.
	//
	// AnomalyDetectorArn is a required field
	AnomalyDetectorArn *string `locationName:"anomalyDetectorArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetLogAnomalyDetectorInput) GoString added in v1.48.4

func (s GetLogAnomalyDetectorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogAnomalyDetectorInput) SetAnomalyDetectorArn added in v1.48.4

func (s *GetLogAnomalyDetectorInput) SetAnomalyDetectorArn(v string) *GetLogAnomalyDetectorInput

SetAnomalyDetectorArn sets the AnomalyDetectorArn field's value.

func (GetLogAnomalyDetectorInput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogAnomalyDetectorInput) Validate added in v1.48.4

func (s *GetLogAnomalyDetectorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLogAnomalyDetectorOutput added in v1.48.4

type GetLogAnomalyDetectorOutput struct {

	// Specifies whether the anomaly detector is currently active. To change its
	// status, use the enabled parameter in the UpdateLogAnomalyDetector (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html)
	// operation.
	AnomalyDetectorStatus *string `locationName:"anomalyDetectorStatus" type:"string" enum:"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 `locationName:"anomalyVisibilityTime" min:"7" type:"long"`

	// The date and time when this anomaly detector was created.
	CreationTimeStamp *int64 `locationName:"creationTimeStamp" type:"long"`

	// The name of the log anomaly detector
	DetectorName *string `locationName:"detectorName" min:"1" type:"string"`

	// Specifies how often the anomaly detector runs and look for anomalies. Set
	// this value according to the frequency that the log group receives new logs.
	// For example, if the log group receives new log events every 10 minutes, then
	// setting evaluationFrequency to FIFTEEN_MIN might be appropriate.
	EvaluationFrequency *string `locationName:"evaluationFrequency" type:"string" enum:"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 `locationName:"filterPattern" type:"string"`

	// The ID of the KMS key assigned to this anomaly detector, if any.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// The date and time when this anomaly detector was most recently modified.
	LastModifiedTimeStamp *int64 `locationName:"lastModifiedTimeStamp" type:"long"`

	// An array of structures, where each structure contains the ARN of a log group
	// associated with this anomaly detector.
	LogGroupArnList []*string `locationName:"logGroupArnList" type:"list"`
	// contains filtered or unexported fields
}

func (GetLogAnomalyDetectorOutput) GoString added in v1.48.4

func (s GetLogAnomalyDetectorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogAnomalyDetectorOutput) SetAnomalyDetectorStatus added in v1.48.4

func (s *GetLogAnomalyDetectorOutput) SetAnomalyDetectorStatus(v string) *GetLogAnomalyDetectorOutput

SetAnomalyDetectorStatus sets the AnomalyDetectorStatus field's value.

func (*GetLogAnomalyDetectorOutput) SetAnomalyVisibilityTime added in v1.48.4

func (s *GetLogAnomalyDetectorOutput) SetAnomalyVisibilityTime(v int64) *GetLogAnomalyDetectorOutput

SetAnomalyVisibilityTime sets the AnomalyVisibilityTime field's value.

func (*GetLogAnomalyDetectorOutput) SetCreationTimeStamp added in v1.48.4

SetCreationTimeStamp sets the CreationTimeStamp field's value.

func (*GetLogAnomalyDetectorOutput) SetDetectorName added in v1.48.4

SetDetectorName sets the DetectorName field's value.

func (*GetLogAnomalyDetectorOutput) SetEvaluationFrequency added in v1.48.4

func (s *GetLogAnomalyDetectorOutput) SetEvaluationFrequency(v string) *GetLogAnomalyDetectorOutput

SetEvaluationFrequency sets the EvaluationFrequency field's value.

func (*GetLogAnomalyDetectorOutput) SetFilterPattern added in v1.48.4

SetFilterPattern sets the FilterPattern field's value.

func (*GetLogAnomalyDetectorOutput) SetKmsKeyId added in v1.48.4

SetKmsKeyId sets the KmsKeyId field's value.

func (*GetLogAnomalyDetectorOutput) SetLastModifiedTimeStamp added in v1.48.4

func (s *GetLogAnomalyDetectorOutput) SetLastModifiedTimeStamp(v int64) *GetLogAnomalyDetectorOutput

SetLastModifiedTimeStamp sets the LastModifiedTimeStamp field's value.

func (*GetLogAnomalyDetectorOutput) SetLogGroupArnList added in v1.48.4

func (s *GetLogAnomalyDetectorOutput) SetLogGroupArnList(v []*string) *GetLogAnomalyDetectorOutput

SetLogGroupArnList sets the LogGroupArnList field's value.

func (GetLogAnomalyDetectorOutput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLogEventsInput

type GetLogEventsInput struct {

	// The end of the time range, expressed as the number of milliseconds after
	// Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than
	// this time are not included.
	EndTime *int64 `locationName:"endTime" type:"long"`

	// The maximum number of log events returned. If you don't specify a limit,
	// the default is as many log events as can fit in a response size of 1 MB (up
	// to 10,000 log events).
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// Specify either the name or ARN of the log group to view events from. If the
	// log group is in a source account and you are using a monitoring account,
	// you must use the log group ARN.
	//
	// You must include either logGroupIdentifier or logGroupName, but not both.
	LogGroupIdentifier *string `locationName:"logGroupIdentifier" min:"1" type:"string"`

	// The name of the log group.
	//
	// You must include either logGroupIdentifier or logGroupName, but not both.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// The name of the log stream.
	//
	// LogStreamName is a required field
	LogStreamName *string `locationName:"logStreamName" min:"1" type:"string" required:"true"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// If the value is true, the earliest log events are returned first. If the
	// value is false, the latest log events are returned first. The default value
	// is false.
	//
	// If you are using a previous nextForwardToken value as the nextToken in this
	// operation, you must specify true for startFromHead.
	StartFromHead *bool `locationName:"startFromHead" type:"boolean"`

	// The start of the time range, expressed as the number of milliseconds after
	// Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later
	// than this time are included. Events with a timestamp earlier than this time
	// are not included.
	StartTime *int64 `locationName:"startTime" type:"long"`

	// Specify true to display the log event fields with all sensitive data unmasked
	// and visible. The default is false.
	//
	// To use this operation with this parameter, you must be signed into an account
	// with the logs:Unmask permission.
	Unmask *bool `locationName:"unmask" type:"boolean"`
	// contains filtered or unexported fields
}

func (GetLogEventsInput) GoString added in v0.6.5

func (s GetLogEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogEventsInput) SetEndTime added in v1.5.0

func (s *GetLogEventsInput) SetEndTime(v int64) *GetLogEventsInput

SetEndTime sets the EndTime field's value.

func (*GetLogEventsInput) SetLimit added in v1.5.0

func (s *GetLogEventsInput) SetLimit(v int64) *GetLogEventsInput

SetLimit sets the Limit field's value.

func (*GetLogEventsInput) SetLogGroupIdentifier added in v1.44.146

func (s *GetLogEventsInput) SetLogGroupIdentifier(v string) *GetLogEventsInput

SetLogGroupIdentifier sets the LogGroupIdentifier field's value.

func (*GetLogEventsInput) SetLogGroupName added in v1.5.0

func (s *GetLogEventsInput) SetLogGroupName(v string) *GetLogEventsInput

SetLogGroupName sets the LogGroupName field's value.

func (*GetLogEventsInput) SetLogStreamName added in v1.5.0

func (s *GetLogEventsInput) SetLogStreamName(v string) *GetLogEventsInput

SetLogStreamName sets the LogStreamName field's value.

func (*GetLogEventsInput) SetNextToken added in v1.5.0

func (s *GetLogEventsInput) SetNextToken(v string) *GetLogEventsInput

SetNextToken sets the NextToken field's value.

func (*GetLogEventsInput) SetStartFromHead added in v1.5.0

func (s *GetLogEventsInput) SetStartFromHead(v bool) *GetLogEventsInput

SetStartFromHead sets the StartFromHead field's value.

func (*GetLogEventsInput) SetStartTime added in v1.5.0

func (s *GetLogEventsInput) SetStartTime(v int64) *GetLogEventsInput

SetStartTime sets the StartTime field's value.

func (*GetLogEventsInput) SetUnmask added in v1.44.146

func (s *GetLogEventsInput) SetUnmask(v bool) *GetLogEventsInput

SetUnmask sets the Unmask field's value.

func (GetLogEventsInput) String added in v0.6.5

func (s GetLogEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogEventsInput) Validate added in v1.1.21

func (s *GetLogEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLogEventsOutput

type GetLogEventsOutput struct {

	// The events.
	Events []*OutputLogEvent `locationName:"events" type:"list"`

	// The token for the next set of items in the backward direction. The token
	// expires after 24 hours. This token is not null. If you have reached the end
	// of the stream, it returns the same token you passed in.
	NextBackwardToken *string `locationName:"nextBackwardToken" min:"1" type:"string"`

	// The token for the next set of items in the forward direction. The token expires
	// after 24 hours. If you have reached the end of the stream, it returns the
	// same token you passed in.
	NextForwardToken *string `locationName:"nextForwardToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetLogEventsOutput) GoString added in v0.6.5

func (s GetLogEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogEventsOutput) SetEvents added in v1.5.0

SetEvents sets the Events field's value.

func (*GetLogEventsOutput) SetNextBackwardToken added in v1.5.0

func (s *GetLogEventsOutput) SetNextBackwardToken(v string) *GetLogEventsOutput

SetNextBackwardToken sets the NextBackwardToken field's value.

func (*GetLogEventsOutput) SetNextForwardToken added in v1.5.0

func (s *GetLogEventsOutput) SetNextForwardToken(v string) *GetLogEventsOutput

SetNextForwardToken sets the NextForwardToken field's value.

func (GetLogEventsOutput) String added in v0.6.5

func (s GetLogEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLogGroupFieldsInput added in v1.15.84

type GetLogGroupFieldsInput struct {

	// Specify either the name or ARN of the log group to view. If the log group
	// is in a source account and you are using a monitoring account, you must specify
	// the ARN.
	//
	// You must include either logGroupIdentifier or logGroupName, but not both.
	LogGroupIdentifier *string `locationName:"logGroupIdentifier" min:"1" type:"string"`

	// The name of the log group to search.
	//
	// You must include either logGroupIdentifier or logGroupName, but not both.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// The time to set as the center of the query. If you specify time, the 8 minutes
	// before and 8 minutes after this time are searched. If you omit time, the
	// most recent 15 minutes up to the current time are searched.
	//
	// The time value is specified as epoch time, which is the number of seconds
	// since January 1, 1970, 00:00:00 UTC.
	Time *int64 `locationName:"time" type:"long"`
	// contains filtered or unexported fields
}

func (GetLogGroupFieldsInput) GoString added in v1.15.84

func (s GetLogGroupFieldsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogGroupFieldsInput) SetLogGroupIdentifier added in v1.44.146

func (s *GetLogGroupFieldsInput) SetLogGroupIdentifier(v string) *GetLogGroupFieldsInput

SetLogGroupIdentifier sets the LogGroupIdentifier field's value.

func (*GetLogGroupFieldsInput) SetLogGroupName added in v1.15.84

func (s *GetLogGroupFieldsInput) SetLogGroupName(v string) *GetLogGroupFieldsInput

SetLogGroupName sets the LogGroupName field's value.

func (*GetLogGroupFieldsInput) SetTime added in v1.15.84

SetTime sets the Time field's value.

func (GetLogGroupFieldsInput) String added in v1.15.84

func (s GetLogGroupFieldsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogGroupFieldsInput) Validate added in v1.15.84

func (s *GetLogGroupFieldsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLogGroupFieldsOutput added in v1.15.84

type GetLogGroupFieldsOutput struct {

	// The array of fields found in the query. Each object in the array contains
	// the name of the field, along with the percentage of time it appeared in the
	// log events that were queried.
	LogGroupFields []*LogGroupField `locationName:"logGroupFields" type:"list"`
	// contains filtered or unexported fields
}

func (GetLogGroupFieldsOutput) GoString added in v1.15.84

func (s GetLogGroupFieldsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogGroupFieldsOutput) SetLogGroupFields added in v1.15.84

SetLogGroupFields sets the LogGroupFields field's value.

func (GetLogGroupFieldsOutput) String added in v1.15.84

func (s GetLogGroupFieldsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLogRecordInput added in v1.15.84

type GetLogRecordInput struct {

	// The pointer corresponding to the log event record you want to retrieve. You
	// get this from the response of a GetQueryResults operation. In that response,
	// the value of the @ptr field for a log event is the value to use as logRecordPointer
	// to retrieve that complete log event record.
	//
	// LogRecordPointer is a required field
	LogRecordPointer *string `locationName:"logRecordPointer" type:"string" required:"true"`

	// Specify true to display the log event fields with all sensitive data unmasked
	// and visible. The default is false.
	//
	// To use this operation with this parameter, you must be signed into an account
	// with the logs:Unmask permission.
	Unmask *bool `locationName:"unmask" type:"boolean"`
	// contains filtered or unexported fields
}

func (GetLogRecordInput) GoString added in v1.15.84

func (s GetLogRecordInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogRecordInput) SetLogRecordPointer added in v1.15.84

func (s *GetLogRecordInput) SetLogRecordPointer(v string) *GetLogRecordInput

SetLogRecordPointer sets the LogRecordPointer field's value.

func (*GetLogRecordInput) SetUnmask added in v1.44.146

func (s *GetLogRecordInput) SetUnmask(v bool) *GetLogRecordInput

SetUnmask sets the Unmask field's value.

func (GetLogRecordInput) String added in v1.15.84

func (s GetLogRecordInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogRecordInput) Validate added in v1.15.84

func (s *GetLogRecordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLogRecordOutput added in v1.15.84

type GetLogRecordOutput struct {

	// The requested log event, as a JSON string.
	LogRecord map[string]*string `locationName:"logRecord" type:"map"`
	// contains filtered or unexported fields
}

func (GetLogRecordOutput) GoString added in v1.15.84

func (s GetLogRecordOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLogRecordOutput) SetLogRecord added in v1.15.84

func (s *GetLogRecordOutput) SetLogRecord(v map[string]*string) *GetLogRecordOutput

SetLogRecord sets the LogRecord field's value.

func (GetLogRecordOutput) String added in v1.15.84

func (s GetLogRecordOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetQueryResultsInput added in v1.15.84

type GetQueryResultsInput struct {

	// The ID number of the query.
	//
	// QueryId is a required field
	QueryId *string `locationName:"queryId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQueryResultsInput) GoString added in v1.15.84

func (s GetQueryResultsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryResultsInput) SetQueryId added in v1.15.84

SetQueryId sets the QueryId field's value.

func (GetQueryResultsInput) String added in v1.15.84

func (s GetQueryResultsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryResultsInput) Validate added in v1.15.84

func (s *GetQueryResultsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQueryResultsOutput added in v1.15.84

type GetQueryResultsOutput struct {

	// If you associated an KMS key with the CloudWatch Logs Insights query results
	// in this account, this field displays the ARN of the key that's used to encrypt
	// the query results when StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html)
	// stores them.
	EncryptionKey *string `locationName:"encryptionKey" type:"string"`

	// The log events that matched the query criteria during the most recent time
	// it ran.
	//
	// The results value is an array of arrays. Each log event is one object in
	// the top-level array. Each of these log event objects is an array of field/value
	// pairs.
	Results [][]*ResultField `locationName:"results" type:"list"`

	// Includes 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 scanned log events. These values reflect the full raw results of the
	// query.
	Statistics *QueryStatistics `locationName:"statistics" type:"structure"`

	// The status of the most recent running of the query. Possible values are Cancelled,
	// Complete, Failed, Running, Scheduled, Timeout, and Unknown.
	//
	// Queries time out after 60 minutes of runtime. To avoid having your queries
	// time out, reduce the time range being searched or partition your query into
	// a number of queries.
	Status *string `locationName:"status" type:"string" enum:"QueryStatus"`
	// contains filtered or unexported fields
}

func (GetQueryResultsOutput) GoString added in v1.15.84

func (s GetQueryResultsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQueryResultsOutput) SetEncryptionKey added in v1.44.298

func (s *GetQueryResultsOutput) SetEncryptionKey(v string) *GetQueryResultsOutput

SetEncryptionKey sets the EncryptionKey field's value.

func (*GetQueryResultsOutput) SetResults added in v1.15.84

SetResults sets the Results field's value.

func (*GetQueryResultsOutput) SetStatistics added in v1.15.84

SetStatistics sets the Statistics field's value.

func (*GetQueryResultsOutput) SetStatus added in v1.15.84

SetStatus sets the Status field's value.

func (GetQueryResultsOutput) String added in v1.15.84

func (s GetQueryResultsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InputLogEvent

type InputLogEvent struct {

	// The raw event message. Each log event can be no larger than 256 KB.
	//
	// Message is a required field
	Message *string `locationName:"message" min:"1" type:"string" required:"true"`

	// The time the event occurred, expressed as the number of milliseconds after
	// Jan 1, 1970 00:00:00 UTC.
	//
	// Timestamp is a required field
	Timestamp *int64 `locationName:"timestamp" type:"long" required:"true"`
	// 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.

func (InputLogEvent) GoString added in v0.6.5

func (s InputLogEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputLogEvent) SetMessage added in v1.5.0

func (s *InputLogEvent) SetMessage(v string) *InputLogEvent

SetMessage sets the Message field's value.

func (*InputLogEvent) SetTimestamp added in v1.5.0

func (s *InputLogEvent) SetTimestamp(v int64) *InputLogEvent

SetTimestamp sets the Timestamp field's value.

func (InputLogEvent) String added in v0.6.5

func (s InputLogEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputLogEvent) Validate added in v1.1.21

func (s *InputLogEvent) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InvalidOperationException added in v1.28.0

type InvalidOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The operation is not valid on the specified resource.

func (*InvalidOperationException) Code added in v1.28.0

Code returns the exception type name.

func (*InvalidOperationException) Error added in v1.28.0

func (s *InvalidOperationException) Error() string

func (InvalidOperationException) GoString added in v1.28.0

func (s InvalidOperationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidOperationException) Message added in v1.28.0

func (s *InvalidOperationException) Message() string

Message returns the exception's message.

func (*InvalidOperationException) OrigErr added in v1.28.0

func (s *InvalidOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidOperationException) RequestID added in v1.28.0

func (s *InvalidOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidOperationException) StatusCode added in v1.28.0

func (s *InvalidOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidOperationException) String added in v1.28.0

func (s InvalidOperationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidParameterException added in v1.28.0

type InvalidParameterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A parameter is specified incorrectly.

func (*InvalidParameterException) Code added in v1.28.0

Code returns the exception type name.

func (*InvalidParameterException) Error added in v1.28.0

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString added in v1.28.0

func (s InvalidParameterException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidParameterException) Message added in v1.28.0

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr added in v1.28.0

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID added in v1.28.0

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode added in v1.28.0

func (s *InvalidParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterException) String added in v1.28.0

func (s InvalidParameterException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidSequenceTokenException added in v1.28.0

type InvalidSequenceTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	ExpectedSequenceToken *string `locationName:"expectedSequenceToken" min:"1" type:"string"`

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0

Code returns the exception type name.

func (*InvalidSequenceTokenException) Error added in v1.28.0

func (InvalidSequenceTokenException) GoString added in v1.28.0

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidSequenceTokenException) Message added in v1.28.0

Message returns the exception's message.

func (*InvalidSequenceTokenException) OrigErr added in v1.28.0

func (s *InvalidSequenceTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidSequenceTokenException) RequestID added in v1.28.0

func (s *InvalidSequenceTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidSequenceTokenException) StatusCode added in v1.28.0

func (s *InvalidSequenceTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidSequenceTokenException) String added in v1.28.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException added in v1.28.0

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*LimitExceededException) Code added in v1.28.0

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAnomaliesInput added in v1.48.4

type ListAnomaliesInput struct {

	// Use this to optionally limit the results to only the anomalies found by a
	// certain anomaly detector.
	AnomalyDetectorArn *string `locationName:"anomalyDetectorArn" min:"1" type:"string"`

	// The maximum number of items to return. If you don't specify a value, the
	// default maximum value of 50 items is used.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// You can specify this parameter if you want to the operation to return only
	// anomalies that are currently either suppressed or unsuppressed.
	SuppressionState *string `locationName:"suppressionState" type:"string" enum:"SuppressionState"`
	// contains filtered or unexported fields
}

func (ListAnomaliesInput) GoString added in v1.48.4

func (s ListAnomaliesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAnomaliesInput) SetAnomalyDetectorArn added in v1.48.4

func (s *ListAnomaliesInput) SetAnomalyDetectorArn(v string) *ListAnomaliesInput

SetAnomalyDetectorArn sets the AnomalyDetectorArn field's value.

func (*ListAnomaliesInput) SetLimit added in v1.48.4

SetLimit sets the Limit field's value.

func (*ListAnomaliesInput) SetNextToken added in v1.48.4

func (s *ListAnomaliesInput) SetNextToken(v string) *ListAnomaliesInput

SetNextToken sets the NextToken field's value.

func (*ListAnomaliesInput) SetSuppressionState added in v1.48.4

func (s *ListAnomaliesInput) SetSuppressionState(v string) *ListAnomaliesInput

SetSuppressionState sets the SuppressionState field's value.

func (ListAnomaliesInput) String added in v1.48.4

func (s ListAnomaliesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAnomaliesInput) Validate added in v1.48.4

func (s *ListAnomaliesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAnomaliesOutput added in v1.48.4

type ListAnomaliesOutput struct {

	// An array of structures, where each structure contains information about one
	// anomaly that a log anomaly detector has found.
	Anomalies []*Anomaly `locationName:"anomalies" type:"list"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAnomaliesOutput) GoString added in v1.48.4

func (s ListAnomaliesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAnomaliesOutput) SetAnomalies added in v1.48.4

func (s *ListAnomaliesOutput) SetAnomalies(v []*Anomaly) *ListAnomaliesOutput

SetAnomalies sets the Anomalies field's value.

func (*ListAnomaliesOutput) SetNextToken added in v1.48.4

func (s *ListAnomaliesOutput) SetNextToken(v string) *ListAnomaliesOutput

SetNextToken sets the NextToken field's value.

func (ListAnomaliesOutput) String added in v1.48.4

func (s ListAnomaliesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListLogAnomalyDetectorsInput added in v1.48.4

type ListLogAnomalyDetectorsInput struct {

	// Use this to optionally filter the results to only include anomaly detectors
	// that are associated with the specified log group.
	FilterLogGroupArn *string `locationName:"filterLogGroupArn" min:"1" type:"string"`

	// The maximum number of items to return. If you don't specify a value, the
	// default maximum value of 50 items is used.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListLogAnomalyDetectorsInput) GoString added in v1.48.4

func (s ListLogAnomalyDetectorsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLogAnomalyDetectorsInput) SetFilterLogGroupArn added in v1.48.4

SetFilterLogGroupArn sets the FilterLogGroupArn field's value.

func (*ListLogAnomalyDetectorsInput) SetLimit added in v1.48.4

SetLimit sets the Limit field's value.

func (*ListLogAnomalyDetectorsInput) SetNextToken added in v1.48.4

SetNextToken sets the NextToken field's value.

func (ListLogAnomalyDetectorsInput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLogAnomalyDetectorsInput) Validate added in v1.48.4

func (s *ListLogAnomalyDetectorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListLogAnomalyDetectorsOutput added in v1.48.4

type ListLogAnomalyDetectorsOutput struct {

	// An array of structures, where each structure in the array contains information
	// about one anomaly detector.
	AnomalyDetectors []*AnomalyDetector `locationName:"anomalyDetectors" type:"list"`

	// The token for the next set of items to return. The token expires after 24
	// hours.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListLogAnomalyDetectorsOutput) GoString added in v1.48.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLogAnomalyDetectorsOutput) SetAnomalyDetectors added in v1.48.4

SetAnomalyDetectors sets the AnomalyDetectors field's value.

func (*ListLogAnomalyDetectorsOutput) SetNextToken added in v1.48.4

SetNextToken sets the NextToken field's value.

func (ListLogAnomalyDetectorsOutput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.44.127

type ListTagsForResourceInput struct {

	// The ARN of the resource that you want to view tags for.
	//
	// The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name
	//
	// The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name
	//
	// For more information about ARN format, see CloudWatch Logs resources and
	// operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html).
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.44.127

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.44.127

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.44.127

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.44.127

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.44.127

type ListTagsForResourceOutput struct {

	// The list of tags associated with the requested resource.>
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.44.127

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.44.127

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.44.127

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsLogGroupInput deprecated added in v1.6.3

type ListTagsLogGroupInput struct {

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Deprecated: Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse

func (ListTagsLogGroupInput) GoString added in v1.6.3

func (s ListTagsLogGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsLogGroupInput) SetLogGroupName added in v1.6.3

func (s *ListTagsLogGroupInput) SetLogGroupName(v string) *ListTagsLogGroupInput

SetLogGroupName sets the LogGroupName field's value.

func (ListTagsLogGroupInput) String added in v1.6.3

func (s ListTagsLogGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsLogGroupInput) Validate added in v1.6.3

func (s *ListTagsLogGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsLogGroupOutput deprecated added in v1.6.3

type ListTagsLogGroupOutput struct {

	// The tags for the log group.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

Deprecated: Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse

func (ListTagsLogGroupOutput) GoString added in v1.6.3

func (s ListTagsLogGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsLogGroupOutput) SetTags added in v1.6.3

SetTags sets the Tags field's value.

func (ListTagsLogGroupOutput) String added in v1.6.3

func (s ListTagsLogGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LiveTailSessionLogEvent added in v1.49.1

type LiveTailSessionLogEvent struct {

	// The timestamp specifying when this log event was ingested into the log group.
	IngestionTime *int64 `locationName:"ingestionTime" type:"long"`

	// The name or ARN of the log group that ingested this log event.
	LogGroupIdentifier *string `locationName:"logGroupIdentifier" min:"1" type:"string"`

	// The name of the log stream that ingested this log event.
	LogStreamName *string `locationName:"logStreamName" min:"1" type:"string"`

	// The log event message text.
	Message *string `locationName:"message" min:"1" type:"string"`

	// The timestamp specifying when this log event was created.
	Timestamp *int64 `locationName:"timestamp" type:"long"`
	// contains filtered or unexported fields
}

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

func (LiveTailSessionLogEvent) GoString added in v1.49.1

func (s LiveTailSessionLogEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LiveTailSessionLogEvent) SetIngestionTime added in v1.49.1

func (s *LiveTailSessionLogEvent) SetIngestionTime(v int64) *LiveTailSessionLogEvent

SetIngestionTime sets the IngestionTime field's value.

func (*LiveTailSessionLogEvent) SetLogGroupIdentifier added in v1.49.1

func (s *LiveTailSessionLogEvent) SetLogGroupIdentifier(v string) *LiveTailSessionLogEvent

SetLogGroupIdentifier sets the LogGroupIdentifier field's value.

func (*LiveTailSessionLogEvent) SetLogStreamName added in v1.49.1

func (s *LiveTailSessionLogEvent) SetLogStreamName(v string) *LiveTailSessionLogEvent

SetLogStreamName sets the LogStreamName field's value.

func (*LiveTailSessionLogEvent) SetMessage added in v1.49.1

SetMessage sets the Message field's value.

func (*LiveTailSessionLogEvent) SetTimestamp added in v1.49.1

SetTimestamp sets the Timestamp field's value.

func (LiveTailSessionLogEvent) String added in v1.49.1

func (s LiveTailSessionLogEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LiveTailSessionMetadata added in v1.49.1

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 `locationName:"sampled" type:"boolean"`
	// 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.

func (LiveTailSessionMetadata) GoString added in v1.49.1

func (s LiveTailSessionMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LiveTailSessionMetadata) SetSampled added in v1.49.1

SetSampled sets the Sampled field's value.

func (LiveTailSessionMetadata) String added in v1.49.1

func (s LiveTailSessionMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LiveTailSessionStart added in v1.49.1

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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
	LogEventFilterPattern *string `locationName:"logEventFilterPattern" type:"string"`

	// An array of the names and ARNs of the log groups included in this Live Tail
	// session.
	LogGroupIdentifiers []*string `locationName:"logGroupIdentifiers" min:"1" type:"list"`

	// 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 `locationName:"logStreamNamePrefixes" min:"1" type:"list"`

	// 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 `locationName:"logStreamNames" min:"1" type:"list"`

	// The unique ID generated by CloudWatch Logs to identify this Live Tail session
	// request.
	RequestId *string `locationName:"requestId" type:"string"`

	// The unique ID generated by CloudWatch Logs to identify this Live Tail session.
	SessionId *string `locationName:"sessionId" type:"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.

func (LiveTailSessionStart) GoString added in v1.49.1

func (s LiveTailSessionStart) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LiveTailSessionStart) MarshalEvent added in v1.49.1

func (s *LiveTailSessionStart) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*LiveTailSessionStart) SetLogEventFilterPattern added in v1.49.1

func (s *LiveTailSessionStart) SetLogEventFilterPattern(v string) *LiveTailSessionStart

SetLogEventFilterPattern sets the LogEventFilterPattern field's value.

func (*LiveTailSessionStart) SetLogGroupIdentifiers added in v1.49.1

func (s *LiveTailSessionStart) SetLogGroupIdentifiers(v []*string) *LiveTailSessionStart

SetLogGroupIdentifiers sets the LogGroupIdentifiers field's value.

func (*LiveTailSessionStart) SetLogStreamNamePrefixes added in v1.49.1

func (s *LiveTailSessionStart) SetLogStreamNamePrefixes(v []*string) *LiveTailSessionStart

SetLogStreamNamePrefixes sets the LogStreamNamePrefixes field's value.

func (*LiveTailSessionStart) SetLogStreamNames added in v1.49.1

func (s *LiveTailSessionStart) SetLogStreamNames(v []*string) *LiveTailSessionStart

SetLogStreamNames sets the LogStreamNames field's value.

func (*LiveTailSessionStart) SetRequestId added in v1.49.1

func (s *LiveTailSessionStart) SetRequestId(v string) *LiveTailSessionStart

SetRequestId sets the RequestId field's value.

func (*LiveTailSessionStart) SetSessionId added in v1.49.1

func (s *LiveTailSessionStart) SetSessionId(v string) *LiveTailSessionStart

SetSessionId sets the SessionId field's value.

func (LiveTailSessionStart) String added in v1.49.1

func (s LiveTailSessionStart) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LiveTailSessionStart) UnmarshalEvent added in v1.49.1

func (s *LiveTailSessionStart) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the LiveTailSessionStart value. This method is only used internally within the SDK's EventStream handling.

type LiveTailSessionUpdate added in v1.49.1

type LiveTailSessionUpdate struct {

	// This object contains the session metadata for a Live Tail session.
	SessionMetadata *LiveTailSessionMetadata `locationName:"sessionMetadata" type:"structure"`

	// 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 `locationName:"sessionResults" type:"list"`
	// contains filtered or unexported fields
}

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

func (LiveTailSessionUpdate) GoString added in v1.49.1

func (s LiveTailSessionUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LiveTailSessionUpdate) MarshalEvent added in v1.49.1

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*LiveTailSessionUpdate) SetSessionMetadata added in v1.49.1

SetSessionMetadata sets the SessionMetadata field's value.

func (*LiveTailSessionUpdate) SetSessionResults added in v1.49.1

SetSessionResults sets the SessionResults field's value.

func (LiveTailSessionUpdate) String added in v1.49.1

func (s LiveTailSessionUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LiveTailSessionUpdate) UnmarshalEvent added in v1.49.1

func (s *LiveTailSessionUpdate) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the LiveTailSessionUpdate value. This method is only used internally within the SDK's EventStream handling.

type LogEvent added in v1.51.3

type LogEvent struct {

	// The message content of the log event.
	Message *string `locationName:"message" min:"1" type:"string"`

	// The time stamp of the log event.
	Timestamp *int64 `locationName:"timestamp" type:"long"`
	// 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.

func (LogEvent) GoString added in v1.51.3

func (s LogEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogEvent) SetMessage added in v1.51.3

func (s *LogEvent) SetMessage(v string) *LogEvent

SetMessage sets the Message field's value.

func (*LogEvent) SetTimestamp added in v1.51.3

func (s *LogEvent) SetTimestamp(v int64) *LogEvent

SetTimestamp sets the Timestamp field's value.

func (LogEvent) String added in v1.51.3

func (s LogEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
	// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html),
	// UntagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html),
	// and ListTagsForResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html).
	// The permissions for those three actions require the ARN version that doesn't
	// include a trailing :*.
	Arn *string `locationName:"arn" type:"string"`

	// The creation time of the log group, expressed as the number of milliseconds
	// after Jan 1, 1970 00:00:00 UTC.
	CreationTime *int64 `locationName:"creationTime" type:"long"`

	// Displays whether this log group has a protection policy, or whether it had
	// one in the past. For more information, see PutDataProtectionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html).
	DataProtectionStatus *string `locationName:"dataProtectionStatus" type:"string" enum:"DataProtectionStatus"`

	// Displays all the properties that this log group has inherited from account-level
	// settings.
	InheritedProperties []*string `locationName:"inheritedProperties" type:"list" enum:"InheritedProperty"`

	// The Amazon Resource Name (ARN) of the KMS key to use when encrypting log
	// data.
	KmsKeyId *string `locationName:"kmsKeyId" type:"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 (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html),
	//    UntagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html),
	//    and ListTagsForResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html).
	LogGroupArn *string `locationName:"logGroupArn" type:"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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)
	LogGroupClass *string `locationName:"logGroupClass" type:"string" enum:"LogGroupClass"`

	// The name of the log group.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// The number of metric filters.
	MetricFilterCount *int64 `locationName:"metricFilterCount" type:"integer"`

	// 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
	// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html).
	RetentionInDays *int64 `locationName:"retentionInDays" type:"integer"`

	// The number of bytes stored.
	StoredBytes *int64 `locationName:"storedBytes" type:"long"`
	// contains filtered or unexported fields
}

Represents a log group.

func (LogGroup) GoString added in v0.6.5

func (s LogGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogGroup) SetArn added in v1.5.0

func (s *LogGroup) SetArn(v string) *LogGroup

SetArn sets the Arn field's value.

func (*LogGroup) SetCreationTime added in v1.5.0

func (s *LogGroup) SetCreationTime(v int64) *LogGroup

SetCreationTime sets the CreationTime field's value.

func (*LogGroup) SetDataProtectionStatus added in v1.44.146

func (s *LogGroup) SetDataProtectionStatus(v string) *LogGroup

SetDataProtectionStatus sets the DataProtectionStatus field's value.

func (*LogGroup) SetInheritedProperties added in v1.44.278

func (s *LogGroup) SetInheritedProperties(v []*string) *LogGroup

SetInheritedProperties sets the InheritedProperties field's value.

func (*LogGroup) SetKmsKeyId added in v1.10.50

func (s *LogGroup) SetKmsKeyId(v string) *LogGroup

SetKmsKeyId sets the KmsKeyId field's value.

func (*LogGroup) SetLogGroupArn added in v1.50.12

func (s *LogGroup) SetLogGroupArn(v string) *LogGroup

SetLogGroupArn sets the LogGroupArn field's value.

func (*LogGroup) SetLogGroupClass added in v1.48.4

func (s *LogGroup) SetLogGroupClass(v string) *LogGroup

SetLogGroupClass sets the LogGroupClass field's value.

func (*LogGroup) SetLogGroupName added in v1.5.0

func (s *LogGroup) SetLogGroupName(v string) *LogGroup

SetLogGroupName sets the LogGroupName field's value.

func (*LogGroup) SetMetricFilterCount added in v1.5.0

func (s *LogGroup) SetMetricFilterCount(v int64) *LogGroup

SetMetricFilterCount sets the MetricFilterCount field's value.

func (*LogGroup) SetRetentionInDays added in v1.5.0

func (s *LogGroup) SetRetentionInDays(v int64) *LogGroup

SetRetentionInDays sets the RetentionInDays field's value.

func (*LogGroup) SetStoredBytes added in v1.5.0

func (s *LogGroup) SetStoredBytes(v int64) *LogGroup

SetStoredBytes sets the StoredBytes field's value.

func (LogGroup) String added in v0.6.5

func (s LogGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LogGroupField added in v1.15.84

type LogGroupField struct {

	// The name of a log field.
	Name *string `locationName:"name" type:"string"`

	// The percentage of log events queried that contained the field.
	Percent *int64 `locationName:"percent" type:"integer"`
	// 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.

func (LogGroupField) GoString added in v1.15.84

func (s LogGroupField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogGroupField) SetName added in v1.15.84

func (s *LogGroupField) SetName(v string) *LogGroupField

SetName sets the Name field's value.

func (*LogGroupField) SetPercent added in v1.15.84

func (s *LogGroupField) SetPercent(v int64) *LogGroupField

SetPercent sets the Percent field's value.

func (LogGroupField) String added in v1.15.84

func (s LogGroupField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LogStream

type LogStream struct {

	// The Amazon Resource Name (ARN) of the log stream.
	Arn *string `locationName:"arn" type:"string"`

	// The creation time of the stream, expressed as the number of milliseconds
	// after Jan 1, 1970 00:00:00 UTC.
	CreationTime *int64 `locationName:"creationTime" type:"long"`

	// The time of the first event, expressed as the number of milliseconds after
	// Jan 1, 1970 00:00:00 UTC.
	FirstEventTimestamp *int64 `locationName:"firstEventTimestamp" type:"long"`

	// 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 `locationName:"lastEventTimestamp" type:"long"`

	// 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 `locationName:"lastIngestionTime" type:"long"`

	// The name of the log stream.
	LogStreamName *string `locationName:"logStreamName" min:"1" type:"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 `locationName:"storedBytes" deprecated:"true" type:"long"`

	// 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 `locationName:"uploadSequenceToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (LogStream) GoString added in v0.6.5

func (s LogStream) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogStream) SetArn added in v1.5.0

func (s *LogStream) SetArn(v string) *LogStream

SetArn sets the Arn field's value.

func (*LogStream) SetCreationTime added in v1.5.0

func (s *LogStream) SetCreationTime(v int64) *LogStream

SetCreationTime sets the CreationTime field's value.

func (*LogStream) SetFirstEventTimestamp added in v1.5.0

func (s *LogStream) SetFirstEventTimestamp(v int64) *LogStream

SetFirstEventTimestamp sets the FirstEventTimestamp field's value.

func (*LogStream) SetLastEventTimestamp added in v1.5.0

func (s *LogStream) SetLastEventTimestamp(v int64) *LogStream

SetLastEventTimestamp sets the LastEventTimestamp field's value.

func (*LogStream) SetLastIngestionTime added in v1.5.0

func (s *LogStream) SetLastIngestionTime(v int64) *LogStream

SetLastIngestionTime sets the LastIngestionTime field's value.

func (*LogStream) SetLogStreamName added in v1.5.0

func (s *LogStream) SetLogStreamName(v string) *LogStream

SetLogStreamName sets the LogStreamName field's value.

func (*LogStream) SetStoredBytes added in v1.5.0

func (s *LogStream) SetStoredBytes(v int64) *LogStream

SetStoredBytes sets the StoredBytes field's value.

func (*LogStream) SetUploadSequenceToken added in v1.5.0

func (s *LogStream) SetUploadSequenceToken(v string) *LogStream

SetUploadSequenceToken sets the UploadSequenceToken field's value.

func (LogStream) String added in v0.6.5

func (s LogStream) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MalformedQueryException added in v1.28.0

type MalformedQueryException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// Reserved.
	QueryCompileError *QueryCompileError `locationName:"queryCompileError" type:"structure"`
	// 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 (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_QueryCompileError.html).

For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).

func (*MalformedQueryException) Code added in v1.28.0

func (s *MalformedQueryException) Code() string

Code returns the exception type name.

func (*MalformedQueryException) Error added in v1.28.0

func (s *MalformedQueryException) Error() string

func (MalformedQueryException) GoString added in v1.28.0

func (s MalformedQueryException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MalformedQueryException) Message added in v1.28.0

func (s *MalformedQueryException) Message() string

Message returns the exception's message.

func (*MalformedQueryException) OrigErr added in v1.28.0

func (s *MalformedQueryException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MalformedQueryException) RequestID added in v1.28.0

func (s *MalformedQueryException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MalformedQueryException) StatusCode added in v1.28.0

func (s *MalformedQueryException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MalformedQueryException) String added in v1.28.0

func (s MalformedQueryException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricFilter

type MetricFilter struct {

	// The creation time of the metric filter, expressed as the number of milliseconds
	// after Jan 1, 1970 00:00:00 UTC.
	CreationTime *int64 `locationName:"creationTime" type:"long"`

	// The name of the metric filter.
	FilterName *string `locationName:"filterName" min:"1" type:"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 `locationName:"filterPattern" type:"string"`

	// The name of the log group.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// The metric transformations.
	MetricTransformations []*MetricTransformation `locationName:"metricTransformations" min:"1" type:"list"`
	// 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.

func (MetricFilter) GoString added in v0.6.5

func (s MetricFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricFilter) SetCreationTime added in v1.5.0

func (s *MetricFilter) SetCreationTime(v int64) *MetricFilter

SetCreationTime sets the CreationTime field's value.

func (*MetricFilter) SetFilterName added in v1.5.0

func (s *MetricFilter) SetFilterName(v string) *MetricFilter

SetFilterName sets the FilterName field's value.

func (*MetricFilter) SetFilterPattern added in v1.5.0

func (s *MetricFilter) SetFilterPattern(v string) *MetricFilter

SetFilterPattern sets the FilterPattern field's value.

func (*MetricFilter) SetLogGroupName added in v1.5.3

func (s *MetricFilter) SetLogGroupName(v string) *MetricFilter

SetLogGroupName sets the LogGroupName field's value.

func (*MetricFilter) SetMetricTransformations added in v1.5.0

func (s *MetricFilter) SetMetricTransformations(v []*MetricTransformation) *MetricFilter

SetMetricTransformations sets the MetricTransformations field's value.

func (MetricFilter) String added in v0.6.5

func (s MetricFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricFilterMatchRecord

type MetricFilterMatchRecord struct {

	// The raw event data.
	EventMessage *string `locationName:"eventMessage" min:"1" type:"string"`

	// The event number.
	EventNumber *int64 `locationName:"eventNumber" type:"long"`

	// The values extracted from the event data by the filter.
	ExtractedValues map[string]*string `locationName:"extractedValues" type:"map"`
	// contains filtered or unexported fields
}

Represents a matched event.

func (MetricFilterMatchRecord) GoString added in v0.6.5

func (s MetricFilterMatchRecord) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricFilterMatchRecord) SetEventMessage added in v1.5.0

SetEventMessage sets the EventMessage field's value.

func (*MetricFilterMatchRecord) SetEventNumber added in v1.5.0

SetEventNumber sets the EventNumber field's value.

func (*MetricFilterMatchRecord) SetExtractedValues added in v1.5.0

func (s *MetricFilterMatchRecord) SetExtractedValues(v map[string]*string) *MetricFilterMatchRecord

SetExtractedValues sets the ExtractedValues field's value.

func (MetricFilterMatchRecord) String added in v0.6.5

func (s MetricFilterMatchRecord) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricTransformation

type MetricTransformation struct {

	// (Optional) The value to emit when a filter pattern does not match a log event.
	// This value can be null.
	DefaultValue *float64 `locationName:"defaultValue" type:"double"`

	// 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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html).
	Dimensions map[string]*string `locationName:"dimensions" type:"map"`

	// The name of the CloudWatch metric.
	//
	// MetricName is a required field
	MetricName *string `locationName:"metricName" type:"string" required:"true"`

	// A custom namespace to contain your metric in CloudWatch. Use namespaces to
	// group together metrics that are similar. For more information, see Namespaces
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace).
	//
	// MetricNamespace is a required field
	MetricNamespace *string `locationName:"metricNamespace" type:"string" required:"true"`

	// The value to publish to the CloudWatch metric when a filter pattern matches
	// a log event.
	//
	// MetricValue is a required field
	MetricValue *string `locationName:"metricValue" type:"string" required:"true"`

	// The unit to assign to the metric. If you omit this, the unit is set as None.
	Unit *string `locationName:"unit" type:"string" enum:"StandardUnit"`
	// contains filtered or unexported fields
}

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

func (MetricTransformation) GoString added in v0.6.5

func (s MetricTransformation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricTransformation) SetDefaultValue added in v1.5.0

func (s *MetricTransformation) SetDefaultValue(v float64) *MetricTransformation

SetDefaultValue sets the DefaultValue field's value.

func (*MetricTransformation) SetDimensions added in v1.38.46

func (s *MetricTransformation) SetDimensions(v map[string]*string) *MetricTransformation

SetDimensions sets the Dimensions field's value.

func (*MetricTransformation) SetMetricName added in v1.5.0

func (s *MetricTransformation) SetMetricName(v string) *MetricTransformation

SetMetricName sets the MetricName field's value.

func (*MetricTransformation) SetMetricNamespace added in v1.5.0

func (s *MetricTransformation) SetMetricNamespace(v string) *MetricTransformation

SetMetricNamespace sets the MetricNamespace field's value.

func (*MetricTransformation) SetMetricValue added in v1.5.0

func (s *MetricTransformation) SetMetricValue(v string) *MetricTransformation

SetMetricValue sets the MetricValue field's value.

func (*MetricTransformation) SetUnit added in v1.38.46

SetUnit sets the Unit field's value.

func (MetricTransformation) String added in v0.6.5

func (s MetricTransformation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricTransformation) Validate added in v1.1.21

func (s *MetricTransformation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OperationAbortedException added in v1.28.0

type OperationAbortedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*OperationAbortedException) Code added in v1.28.0

Code returns the exception type name.

func (*OperationAbortedException) Error added in v1.28.0

func (s *OperationAbortedException) Error() string

func (OperationAbortedException) GoString added in v1.28.0

func (s OperationAbortedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OperationAbortedException) Message added in v1.28.0

func (s *OperationAbortedException) Message() string

Message returns the exception's message.

func (*OperationAbortedException) OrigErr added in v1.28.0

func (s *OperationAbortedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OperationAbortedException) RequestID added in v1.28.0

func (s *OperationAbortedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OperationAbortedException) StatusCode added in v1.28.0

func (s *OperationAbortedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OperationAbortedException) String added in v1.28.0

func (s OperationAbortedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `locationName:"ingestionTime" type:"long"`

	// The data contained in the log event.
	Message *string `locationName:"message" min:"1" type:"string"`

	// The time the event occurred, expressed as the number of milliseconds after
	// Jan 1, 1970 00:00:00 UTC.
	Timestamp *int64 `locationName:"timestamp" type:"long"`
	// contains filtered or unexported fields
}

Represents a log event.

func (OutputLogEvent) GoString added in v0.6.5

func (s OutputLogEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputLogEvent) SetIngestionTime added in v1.5.0

func (s *OutputLogEvent) SetIngestionTime(v int64) *OutputLogEvent

SetIngestionTime sets the IngestionTime field's value.

func (*OutputLogEvent) SetMessage added in v1.5.0

func (s *OutputLogEvent) SetMessage(v string) *OutputLogEvent

SetMessage sets the Message field's value.

func (*OutputLogEvent) SetTimestamp added in v1.5.0

func (s *OutputLogEvent) SetTimestamp(v int64) *OutputLogEvent

SetTimestamp sets the Timestamp field's value.

func (OutputLogEvent) String added in v0.6.5

func (s OutputLogEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PatternToken added in v1.48.4

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 *int64 `locationName:"dynamicTokenPosition" type:"integer"`

	// Contains the values found for a dynamic token, and the number of times each
	// value was found.
	Enumerations map[string]*int64 `locationName:"enumerations" type:"map"`

	// Specifies whether this is a dynamic token.
	IsDynamic *bool `locationName:"isDynamic" type:"boolean"`

	// The string represented by this token. If this is a dynamic token, the value
	// will be <*>
	TokenString *string `locationName:"tokenString" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

For more information about patterns and tokens, see CreateLogAnomalyDetector (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogAnomalyDetector.html).

func (PatternToken) GoString added in v1.48.4

func (s PatternToken) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PatternToken) SetDynamicTokenPosition added in v1.48.4

func (s *PatternToken) SetDynamicTokenPosition(v int64) *PatternToken

SetDynamicTokenPosition sets the DynamicTokenPosition field's value.

func (*PatternToken) SetEnumerations added in v1.48.4

func (s *PatternToken) SetEnumerations(v map[string]*int64) *PatternToken

SetEnumerations sets the Enumerations field's value.

func (*PatternToken) SetIsDynamic added in v1.48.4

func (s *PatternToken) SetIsDynamic(v bool) *PatternToken

SetIsDynamic sets the IsDynamic field's value.

func (*PatternToken) SetTokenString added in v1.48.4

func (s *PatternToken) SetTokenString(v string) *PatternToken

SetTokenString sets the TokenString field's value.

func (PatternToken) String added in v1.48.4

func (s PatternToken) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Policy added in v1.47.8

type Policy struct {

	// The contents of the delivery destination policy.
	DeliveryDestinationPolicy *string `locationName:"deliveryDestinationPolicy" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A structure that contains information about one delivery destination policy.

func (Policy) GoString added in v1.47.8

func (s Policy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Policy) SetDeliveryDestinationPolicy added in v1.47.8

func (s *Policy) SetDeliveryDestinationPolicy(v string) *Policy

SetDeliveryDestinationPolicy sets the DeliveryDestinationPolicy field's value.

func (Policy) String added in v1.47.8

func (s Policy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutAccountPolicyInput added in v1.44.278

type PutAccountPolicyInput struct {

	// Specify the policy, in JSON.
	//
	// Data protection policy
	//
	// A data protection policy must include two JSON blocks:
	//
	//    * The first block must include both a DataIdentifer array and an Operation
	//    property with an Audit action. The DataIdentifer array lists the types
	//    of sensitive data that you want to mask. For more information about the
	//    available options, see Types of data that you can mask (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html).
	//    The Operation property with an Audit action is required to find the sensitive
	//    data terms. This Audit action must contain a FindingsDestination object.
	//    You can optionally use that FindingsDestination object to list one or
	//    more destinations to send audit findings to. If you specify destinations
	//    such as log groups, Firehose streams, and S3 buckets, they must already
	//    exist.
	//
	//    * The second block must include both a DataIdentifer array and an Operation
	//    property with an Deidentify action. The DataIdentifer array must exactly
	//    match the DataIdentifer array in the first block of the policy. The Operation
	//    property with the Deidentify action is what actually masks the data, and
	//    it must contain the "MaskConfig": {} object. The "MaskConfig": {} object
	//    must be empty.
	//
	// For an example data protection policy, see the Examples section on this page.
	//
	// The contents of the two DataIdentifer arrays must match exactly.
	//
	// In addition to the two JSON blocks, the policyDocument can also include Name,
	// Description, and Version fields. The Name is different than the operation's
	// policyName parameter, and is used as a dimension when CloudWatch Logs reports
	// audit findings metrics to CloudWatch.
	//
	// The JSON specified in policyDocument can be up to 30,720 characters long.
	//
	// Subscription filter policy
	//
	// A subscription filter policy can include the following attributes in a JSON
	// block:
	//
	//    * DestinationArn The ARN of the destination to deliver log events to.
	//    Supported destinations are: An Kinesis Data Streams data stream in the
	//    same account as the subscription policy, for same-account delivery. An
	//    Firehose data stream in the same account as the subscription policy, for
	//    same-account delivery. A Lambda function in the same account as the subscription
	//    policy, for same-account delivery. A logical destination in a different
	//    account created with PutDestination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html),
	//    for cross-account delivery. Kinesis Data Streams and Firehose are supported
	//    as logical destinations.
	//
	//    * RoleArn The ARN of an IAM role that grants CloudWatch Logs permissions
	//    to deliver ingested log events to the destination stream. You don't need
	//    to provide the ARN when you are working with a logical destination for
	//    cross-account delivery.
	//
	//    * FilterPattern A filter pattern for subscribing to a filtered stream
	//    of log events.
	//
	//    * DistributionThe method used to distribute log data to the destination.
	//    By default, log data is grouped by log stream, but the grouping can be
	//    set to Random for a more even distribution. This property is only applicable
	//    when the destination is an Kinesis Data Streams data stream.
	//
	// PolicyDocument is a required field
	PolicyDocument *string `locationName:"policyDocument" type:"string" required:"true"`

	// A name for the policy. This must be unique within the account.
	//
	// PolicyName is a required field
	PolicyName *string `locationName:"policyName" type:"string" required:"true"`

	// The type of policy that you're creating or updating.
	//
	// PolicyType is a required field
	PolicyType *string `locationName:"policyType" type:"string" required:"true" enum:"PolicyType"`

	// Currently the only valid value for this parameter is ALL, which specifies
	// that the data protection policy applies to all log groups in the account.
	// If you omit this parameter, the default of ALL is used.
	Scope *string `locationName:"scope" type:"string" enum:"Scope"`

	// Use this parameter to apply the subscription filter policy to a subset of
	// log groups in the account. Currently, the only supported filter is LogGroupName
	// NOT IN []. The selectionCriteria string can be up to 25KB in length. The
	// length is determined by using its UTF-8 bytes.
	//
	// Using the selectionCriteria parameter is useful to help prevent infinite
	// loops. For more information, see Log recursion prevention (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions-recursion-prevention.html).
	//
	// Specifing selectionCriteria is valid only when you specify SUBSCRIPTION_FILTER_POLICY
	// for policyType.
	SelectionCriteria *string `locationName:"selectionCriteria" type:"string"`
	// contains filtered or unexported fields
}

func (PutAccountPolicyInput) GoString added in v1.44.278

func (s PutAccountPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountPolicyInput) SetPolicyDocument added in v1.44.278

func (s *PutAccountPolicyInput) SetPolicyDocument(v string) *PutAccountPolicyInput

SetPolicyDocument sets the PolicyDocument field's value.

func (*PutAccountPolicyInput) SetPolicyName added in v1.44.278

func (s *PutAccountPolicyInput) SetPolicyName(v string) *PutAccountPolicyInput

SetPolicyName sets the PolicyName field's value.

func (*PutAccountPolicyInput) SetPolicyType added in v1.44.278

func (s *PutAccountPolicyInput) SetPolicyType(v string) *PutAccountPolicyInput

SetPolicyType sets the PolicyType field's value.

func (*PutAccountPolicyInput) SetScope added in v1.44.278

SetScope sets the Scope field's value.

func (*PutAccountPolicyInput) SetSelectionCriteria added in v1.49.18

func (s *PutAccountPolicyInput) SetSelectionCriteria(v string) *PutAccountPolicyInput

SetSelectionCriteria sets the SelectionCriteria field's value.

func (PutAccountPolicyInput) String added in v1.44.278

func (s PutAccountPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountPolicyInput) Validate added in v1.44.278

func (s *PutAccountPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutAccountPolicyOutput added in v1.44.278

type PutAccountPolicyOutput struct {

	// The account policy that you created.
	AccountPolicy *AccountPolicy `locationName:"accountPolicy" type:"structure"`
	// contains filtered or unexported fields
}

func (PutAccountPolicyOutput) GoString added in v1.44.278

func (s PutAccountPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAccountPolicyOutput) SetAccountPolicy added in v1.44.278

SetAccountPolicy sets the AccountPolicy field's value.

func (PutAccountPolicyOutput) String added in v1.44.278

func (s PutAccountPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutDataProtectionPolicyInput added in v1.44.146

type PutDataProtectionPolicyInput struct {

	// Specify either the log group name or log group ARN.
	//
	// LogGroupIdentifier is a required field
	LogGroupIdentifier *string `locationName:"logGroupIdentifier" min:"1" type:"string" required:"true"`

	// Specify the data protection policy, in JSON.
	//
	// This policy must include two JSON blocks:
	//
	//    * The first block must include both a DataIdentifer array and an Operation
	//    property with an Audit action. The DataIdentifer array lists the types
	//    of sensitive data that you want to mask. For more information about the
	//    available options, see Types of data that you can mask (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html).
	//    The Operation property with an Audit action is required to find the sensitive
	//    data terms. This Audit action must contain a FindingsDestination object.
	//    You can optionally use that FindingsDestination object to list one or
	//    more destinations to send audit findings to. If you specify destinations
	//    such as log groups, Firehose streams, and S3 buckets, they must already
	//    exist.
	//
	//    * The second block must include both a DataIdentifer array and an Operation
	//    property with an Deidentify action. The DataIdentifer array must exactly
	//    match the DataIdentifer array in the first block of the policy. The Operation
	//    property with the Deidentify action is what actually masks the data, and
	//    it must contain the "MaskConfig": {} object. The "MaskConfig": {} object
	//    must be empty.
	//
	// For an example data protection policy, see the Examples section on this page.
	//
	// The contents of the two DataIdentifer arrays must match exactly.
	//
	// In addition to the two JSON blocks, the policyDocument can also include Name,
	// Description, and Version fields. The Name is used as a dimension when CloudWatch
	// Logs reports audit findings metrics to CloudWatch.
	//
	// The JSON specified in policyDocument can be up to 30,720 characters.
	//
	// PolicyDocument is a required field
	PolicyDocument *string `locationName:"policyDocument" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutDataProtectionPolicyInput) GoString added in v1.44.146

func (s PutDataProtectionPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDataProtectionPolicyInput) SetLogGroupIdentifier added in v1.44.146

SetLogGroupIdentifier sets the LogGroupIdentifier field's value.

func (*PutDataProtectionPolicyInput) SetPolicyDocument added in v1.44.146

SetPolicyDocument sets the PolicyDocument field's value.

func (PutDataProtectionPolicyInput) String added in v1.44.146

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDataProtectionPolicyInput) Validate added in v1.44.146

func (s *PutDataProtectionPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutDataProtectionPolicyOutput added in v1.44.146

type PutDataProtectionPolicyOutput struct {

	// The date and time that this policy was most recently updated.
	LastUpdatedTime *int64 `locationName:"lastUpdatedTime" type:"long"`

	// The log group name or ARN that you specified in your request.
	LogGroupIdentifier *string `locationName:"logGroupIdentifier" min:"1" type:"string"`

	// The data protection policy used for this log group.
	PolicyDocument *string `locationName:"policyDocument" type:"string"`
	// contains filtered or unexported fields
}

func (PutDataProtectionPolicyOutput) GoString added in v1.44.146

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDataProtectionPolicyOutput) SetLastUpdatedTime added in v1.44.146

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*PutDataProtectionPolicyOutput) SetLogGroupIdentifier added in v1.44.146

SetLogGroupIdentifier sets the LogGroupIdentifier field's value.

func (*PutDataProtectionPolicyOutput) SetPolicyDocument added in v1.44.146

SetPolicyDocument sets the PolicyDocument field's value.

func (PutDataProtectionPolicyOutput) String added in v1.44.146

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutDeliveryDestinationInput added in v1.47.8

type PutDeliveryDestinationInput struct {

	// A structure that contains the ARN of the Amazon Web Services resource that
	// will receive the logs.
	//
	// DeliveryDestinationConfiguration is a required field
	DeliveryDestinationConfiguration *DeliveryDestinationConfiguration `locationName:"deliveryDestinationConfiguration" type:"structure" required:"true"`

	// A name for this delivery destination. This name must be unique for all delivery
	// destinations in your account.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The format for the logs that this delivery destination will receive.
	OutputFormat *string `locationName:"outputFormat" type:"string" enum:"OutputFormat"`

	// An optional list of key-value pairs to associate with the resource.
	//
	// For more information about tagging, see Tagging Amazon Web Services resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (PutDeliveryDestinationInput) GoString added in v1.47.8

func (s PutDeliveryDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDeliveryDestinationInput) SetDeliveryDestinationConfiguration added in v1.47.8

SetDeliveryDestinationConfiguration sets the DeliveryDestinationConfiguration field's value.

func (*PutDeliveryDestinationInput) SetName added in v1.47.8

SetName sets the Name field's value.

func (*PutDeliveryDestinationInput) SetOutputFormat added in v1.47.8

SetOutputFormat sets the OutputFormat field's value.

func (*PutDeliveryDestinationInput) SetTags added in v1.47.8

SetTags sets the Tags field's value.

func (PutDeliveryDestinationInput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDeliveryDestinationInput) Validate added in v1.47.8

func (s *PutDeliveryDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutDeliveryDestinationOutput added in v1.47.8

type PutDeliveryDestinationOutput struct {

	// A structure containing information about the delivery destination that you
	// just created or updated.
	DeliveryDestination *DeliveryDestination `locationName:"deliveryDestination" type:"structure"`
	// contains filtered or unexported fields
}

func (PutDeliveryDestinationOutput) GoString added in v1.47.8

func (s PutDeliveryDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDeliveryDestinationOutput) SetDeliveryDestination added in v1.47.8

SetDeliveryDestination sets the DeliveryDestination field's value.

func (PutDeliveryDestinationOutput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutDeliveryDestinationPolicyInput added in v1.47.8

type PutDeliveryDestinationPolicyInput struct {

	// The name of the delivery destination to assign this policy to.
	//
	// DeliveryDestinationName is a required field
	DeliveryDestinationName *string `locationName:"deliveryDestinationName" min:"1" type:"string" required:"true"`

	// The contents of the policy.
	//
	// DeliveryDestinationPolicy is a required field
	DeliveryDestinationPolicy *string `locationName:"deliveryDestinationPolicy" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutDeliveryDestinationPolicyInput) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDeliveryDestinationPolicyInput) SetDeliveryDestinationName added in v1.47.8

SetDeliveryDestinationName sets the DeliveryDestinationName field's value.

func (*PutDeliveryDestinationPolicyInput) SetDeliveryDestinationPolicy added in v1.47.8

SetDeliveryDestinationPolicy sets the DeliveryDestinationPolicy field's value.

func (PutDeliveryDestinationPolicyInput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDeliveryDestinationPolicyInput) Validate added in v1.47.8

Validate inspects the fields of the type to determine if they are valid.

type PutDeliveryDestinationPolicyOutput added in v1.47.8

type PutDeliveryDestinationPolicyOutput struct {

	// The contents of the policy that you just created.
	Policy *Policy `locationName:"policy" type:"structure"`
	// contains filtered or unexported fields
}

func (PutDeliveryDestinationPolicyOutput) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDeliveryDestinationPolicyOutput) SetPolicy added in v1.47.8

SetPolicy sets the Policy field's value.

func (PutDeliveryDestinationPolicyOutput) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutDeliverySourceInput added in v1.47.8

type PutDeliverySourceInput struct {

	// Defines the type of log that the source is sending.
	//
	//    * For Amazon CodeWhisperer, the valid value is EVENT_LOGS.
	//
	//    * For IAM Identity Centerr, the valid value is ERROR_LOGS.
	//
	//    * For Amazon WorkMail, the valid values are ACCESS_CONTROL_LOGS, AUTHENTICATION_LOGS,
	//    WORKMAIL_AVAILABILITY_PROVIDER_LOGS, and WORKMAIL_MAILBOX_ACCESS_LOGS.
	//
	// LogType is a required field
	LogType *string `locationName:"logType" min:"1" type:"string" required:"true"`

	// A name for this delivery source. This name must be unique for all delivery
	// sources in your account.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The ARN of the Amazon Web Services resource that is generating and sending
	// logs. For example, arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`

	// An optional list of key-value pairs to associate with the resource.
	//
	// For more information about tagging, see Tagging Amazon Web Services resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (PutDeliverySourceInput) GoString added in v1.47.8

func (s PutDeliverySourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDeliverySourceInput) SetLogType added in v1.47.8

SetLogType sets the LogType field's value.

func (*PutDeliverySourceInput) SetName added in v1.47.8

SetName sets the Name field's value.

func (*PutDeliverySourceInput) SetResourceArn added in v1.47.8

SetResourceArn sets the ResourceArn field's value.

func (*PutDeliverySourceInput) SetTags added in v1.47.8

SetTags sets the Tags field's value.

func (PutDeliverySourceInput) String added in v1.47.8

func (s PutDeliverySourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDeliverySourceInput) Validate added in v1.47.8

func (s *PutDeliverySourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutDeliverySourceOutput added in v1.47.8

type PutDeliverySourceOutput struct {

	// A structure containing information about the delivery source that was just
	// created or updated.
	DeliverySource *DeliverySource `locationName:"deliverySource" type:"structure"`
	// contains filtered or unexported fields
}

func (PutDeliverySourceOutput) GoString added in v1.47.8

func (s PutDeliverySourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDeliverySourceOutput) SetDeliverySource added in v1.47.8

SetDeliverySource sets the DeliverySource field's value.

func (PutDeliverySourceOutput) String added in v1.47.8

func (s PutDeliverySourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutDestinationInput added in v0.7.1

type PutDestinationInput struct {

	// A name for the destination.
	//
	// DestinationName is a required field
	DestinationName *string `locationName:"destinationName" min:"1" type:"string" required:"true"`

	// The ARN of an IAM role that grants CloudWatch Logs permissions to call the
	// Amazon Kinesis PutRecord operation on the destination stream.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`

	// An optional list of key-value pairs to associate with the resource.
	//
	// For more information about tagging, see Tagging Amazon Web Services resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`

	// The ARN of an Amazon Kinesis stream to which to deliver matching log events.
	//
	// TargetArn is a required field
	TargetArn *string `locationName:"targetArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutDestinationInput) GoString added in v0.7.1

func (s PutDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDestinationInput) SetDestinationName added in v1.5.0

func (s *PutDestinationInput) SetDestinationName(v string) *PutDestinationInput

SetDestinationName sets the DestinationName field's value.

func (*PutDestinationInput) SetRoleArn added in v1.5.0

SetRoleArn sets the RoleArn field's value.

func (*PutDestinationInput) SetTags added in v1.44.127

SetTags sets the Tags field's value.

func (*PutDestinationInput) SetTargetArn added in v1.5.0

func (s *PutDestinationInput) SetTargetArn(v string) *PutDestinationInput

SetTargetArn sets the TargetArn field's value.

func (PutDestinationInput) String added in v0.7.1

func (s PutDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDestinationInput) Validate added in v1.1.21

func (s *PutDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutDestinationOutput added in v0.7.1

type PutDestinationOutput struct {

	// The destination.
	Destination *Destination `locationName:"destination" type:"structure"`
	// contains filtered or unexported fields
}

func (PutDestinationOutput) GoString added in v0.7.1

func (s PutDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDestinationOutput) SetDestination added in v1.5.0

func (s *PutDestinationOutput) SetDestination(v *Destination) *PutDestinationOutput

SetDestination sets the Destination field's value.

func (PutDestinationOutput) String added in v0.7.1

func (s PutDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutDestinationPolicyInput added in v0.7.1

type PutDestinationPolicyInput struct {

	// An IAM policy document that authorizes cross-account users to deliver their
	// log events to the associated destination. This can be up to 5120 bytes.
	//
	// AccessPolicy is a required field
	AccessPolicy *string `locationName:"accessPolicy" min:"1" type:"string" required:"true"`

	// A name for an existing destination.
	//
	// DestinationName is a required field
	DestinationName *string `locationName:"destinationName" min:"1" type:"string" required:"true"`

	// Specify true if you are updating an existing destination policy to grant
	// permission to an organization ID instead of granting permission to individual
	// Amazon Web Services accounts. Before you update a destination policy this
	// way, you must first update the subscription filters in the accounts that
	// send logs to this destination. If you do not, the subscription filters might
	// stop working. By specifying true for forceUpdate, you are affirming that
	// you have already updated the subscription filters. For more information,
	// see Updating an existing cross-account subscription (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Cross-Account-Log_Subscription-Update.html)
	//
	// If you omit this parameter, the default of false is used.
	ForceUpdate *bool `locationName:"forceUpdate" type:"boolean"`
	// contains filtered or unexported fields
}

func (PutDestinationPolicyInput) GoString added in v0.7.1

func (s PutDestinationPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDestinationPolicyInput) SetAccessPolicy added in v1.5.0

SetAccessPolicy sets the AccessPolicy field's value.

func (*PutDestinationPolicyInput) SetDestinationName added in v1.5.0

SetDestinationName sets the DestinationName field's value.

func (*PutDestinationPolicyInput) SetForceUpdate added in v1.42.21

SetForceUpdate sets the ForceUpdate field's value.

func (PutDestinationPolicyInput) String added in v0.7.1

func (s PutDestinationPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDestinationPolicyInput) Validate added in v1.1.21

func (s *PutDestinationPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutDestinationPolicyOutput added in v0.7.1

type PutDestinationPolicyOutput struct {
	// contains filtered or unexported fields
}

func (PutDestinationPolicyOutput) GoString added in v0.7.1

func (s PutDestinationPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutDestinationPolicyOutput) String added in v0.7.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutLogEventsInput

type PutLogEventsInput struct {

	// The log events.
	//
	// LogEvents is a required field
	LogEvents []*InputLogEvent `locationName:"logEvents" min:"1" type:"list" required:"true"`

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`

	// The name of the log stream.
	//
	// LogStreamName is a required field
	LogStreamName *string `locationName:"logStreamName" min:"1" type:"string" required:"true"`

	// The sequence token obtained from the response of the previous PutLogEvents
	// call.
	//
	// The sequenceToken parameter is now ignored in PutLogEvents actions. PutLogEvents
	// actions are now accepted and never return InvalidSequenceTokenException or
	// DataAlreadyAcceptedException even if the sequence token is not valid.
	SequenceToken *string `locationName:"sequenceToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutLogEventsInput) GoString added in v0.6.5

func (s PutLogEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutLogEventsInput) SetLogEvents added in v1.5.0

func (s *PutLogEventsInput) SetLogEvents(v []*InputLogEvent) *PutLogEventsInput

SetLogEvents sets the LogEvents field's value.

func (*PutLogEventsInput) SetLogGroupName added in v1.5.0

func (s *PutLogEventsInput) SetLogGroupName(v string) *PutLogEventsInput

SetLogGroupName sets the LogGroupName field's value.

func (*PutLogEventsInput) SetLogStreamName added in v1.5.0

func (s *PutLogEventsInput) SetLogStreamName(v string) *PutLogEventsInput

SetLogStreamName sets the LogStreamName field's value.

func (*PutLogEventsInput) SetSequenceToken added in v1.5.0

func (s *PutLogEventsInput) SetSequenceToken(v string) *PutLogEventsInput

SetSequenceToken sets the SequenceToken field's value.

func (PutLogEventsInput) String added in v0.6.5

func (s PutLogEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutLogEventsInput) Validate added in v1.1.21

func (s *PutLogEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutLogEventsOutput

type PutLogEventsOutput struct {

	// The next sequence token.
	//
	// This field has been deprecated.
	//
	// The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions
	// are always accepted even if the sequence token is not valid. You can use
	// parallel PutLogEvents actions on the same log stream and you do not need
	// to wait for the response of a previous PutLogEvents action to obtain the
	// nextSequenceToken value.
	NextSequenceToken *string `locationName:"nextSequenceToken" min:"1" type:"string"`

	// The rejected events.
	RejectedLogEventsInfo *RejectedLogEventsInfo `locationName:"rejectedLogEventsInfo" type:"structure"`
	// contains filtered or unexported fields
}

func (PutLogEventsOutput) GoString added in v0.6.5

func (s PutLogEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutLogEventsOutput) SetNextSequenceToken added in v1.5.0

func (s *PutLogEventsOutput) SetNextSequenceToken(v string) *PutLogEventsOutput

SetNextSequenceToken sets the NextSequenceToken field's value.

func (*PutLogEventsOutput) SetRejectedLogEventsInfo added in v1.5.0

func (s *PutLogEventsOutput) SetRejectedLogEventsInfo(v *RejectedLogEventsInfo) *PutLogEventsOutput

SetRejectedLogEventsInfo sets the RejectedLogEventsInfo field's value.

func (PutLogEventsOutput) String added in v0.6.5

func (s PutLogEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutMetricFilterInput

type PutMetricFilterInput struct {

	// A name for the metric filter.
	//
	// FilterName is a required field
	FilterName *string `locationName:"filterName" min:"1" type:"string" required:"true"`

	// A filter pattern for extracting metric data out of ingested log events.
	//
	// FilterPattern is a required field
	FilterPattern *string `locationName:"filterPattern" type:"string" required:"true"`

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`

	// A collection of information that defines how metric data gets emitted.
	//
	// MetricTransformations is a required field
	MetricTransformations []*MetricTransformation `locationName:"metricTransformations" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutMetricFilterInput) GoString added in v0.6.5

func (s PutMetricFilterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutMetricFilterInput) SetFilterName added in v1.5.0

func (s *PutMetricFilterInput) SetFilterName(v string) *PutMetricFilterInput

SetFilterName sets the FilterName field's value.

func (*PutMetricFilterInput) SetFilterPattern added in v1.5.0

func (s *PutMetricFilterInput) SetFilterPattern(v string) *PutMetricFilterInput

SetFilterPattern sets the FilterPattern field's value.

func (*PutMetricFilterInput) SetLogGroupName added in v1.5.0

func (s *PutMetricFilterInput) SetLogGroupName(v string) *PutMetricFilterInput

SetLogGroupName sets the LogGroupName field's value.

func (*PutMetricFilterInput) SetMetricTransformations added in v1.5.0

func (s *PutMetricFilterInput) SetMetricTransformations(v []*MetricTransformation) *PutMetricFilterInput

SetMetricTransformations sets the MetricTransformations field's value.

func (PutMetricFilterInput) String added in v0.6.5

func (s PutMetricFilterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutMetricFilterInput) Validate added in v1.1.21

func (s *PutMetricFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutMetricFilterOutput

type PutMetricFilterOutput struct {
	// contains filtered or unexported fields
}

func (PutMetricFilterOutput) GoString added in v0.6.5

func (s PutMetricFilterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutMetricFilterOutput) String added in v0.6.5

func (s PutMetricFilterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutQueryDefinitionInput added in v1.30.23

type PutQueryDefinitionInput struct {

	// Used as an idempotency token, to avoid returning an exception if the service
	// receives the same request twice because of a network error.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// Use this parameter to include specific log groups as part of your query definition.
	//
	// If you are updating a query definition and you omit this parameter, then
	// the updated definition will contain no log groups.
	LogGroupNames []*string `locationName:"logGroupNames" type:"list"`

	// A name for the query definition. If you are saving numerous query definitions,
	// we recommend that you name them. This way, you can find the ones you want
	// by using the first part of the name as a filter in the queryDefinitionNamePrefix
	// parameter of DescribeQueryDefinitions (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html).
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// If you are updating a query definition, use this parameter to specify the
	// ID of the query definition that you want to update. You can use DescribeQueryDefinitions
	// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html)
	// to retrieve the IDs of your saved query definitions.
	//
	// If you are creating a query definition, do not specify this parameter. CloudWatch
	// generates a unique ID for the new query definition and include it in the
	// response to this operation.
	QueryDefinitionId *string `locationName:"queryDefinitionId" type:"string"`

	// The query string to use for this definition. For more information, see CloudWatch
	// Logs Insights Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).
	//
	// QueryString is a required field
	QueryString *string `locationName:"queryString" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutQueryDefinitionInput) GoString added in v1.30.23

func (s PutQueryDefinitionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutQueryDefinitionInput) SetClientToken added in v1.45.14

SetClientToken sets the ClientToken field's value.

func (*PutQueryDefinitionInput) SetLogGroupNames added in v1.30.23

func (s *PutQueryDefinitionInput) SetLogGroupNames(v []*string) *PutQueryDefinitionInput

SetLogGroupNames sets the LogGroupNames field's value.

func (*PutQueryDefinitionInput) SetName added in v1.30.23

SetName sets the Name field's value.

func (*PutQueryDefinitionInput) SetQueryDefinitionId added in v1.30.23

func (s *PutQueryDefinitionInput) SetQueryDefinitionId(v string) *PutQueryDefinitionInput

SetQueryDefinitionId sets the QueryDefinitionId field's value.

func (*PutQueryDefinitionInput) SetQueryString added in v1.30.23

SetQueryString sets the QueryString field's value.

func (PutQueryDefinitionInput) String added in v1.30.23

func (s PutQueryDefinitionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutQueryDefinitionInput) Validate added in v1.30.23

func (s *PutQueryDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutQueryDefinitionOutput added in v1.30.23

type PutQueryDefinitionOutput struct {

	// The ID of the query definition.
	QueryDefinitionId *string `locationName:"queryDefinitionId" type:"string"`
	// contains filtered or unexported fields
}

func (PutQueryDefinitionOutput) GoString added in v1.30.23

func (s PutQueryDefinitionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutQueryDefinitionOutput) SetQueryDefinitionId added in v1.30.23

func (s *PutQueryDefinitionOutput) SetQueryDefinitionId(v string) *PutQueryDefinitionOutput

SetQueryDefinitionId sets the QueryDefinitionId field's value.

func (PutQueryDefinitionOutput) String added in v1.30.23

func (s PutQueryDefinitionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutResourcePolicyInput added in v1.10.41

type PutResourcePolicyInput struct {

	// Details of the new policy, including the identity of the principal that is
	// enabled to put logs to this account. This is formatted as a JSON string.
	// This parameter is required.
	//
	// The following example creates a resource policy enabling the Route 53 service
	// to put DNS query logs in to the specified log group. Replace "logArn" with
	// the ARN of your CloudWatch Logs resource, such as a log group or log stream.
	//
	// CloudWatch Logs also supports aws:SourceArn (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn)
	// and aws:SourceAccount (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount)
	// condition context keys.
	//
	// In the example resource policy, you would replace the value of SourceArn
	// with the resource making the call from Route 53 to CloudWatch Logs. You would
	// also replace the value of SourceAccount with the Amazon Web Services account
	// ID making that call.
	//
	// { "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs",
	// "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ]
	// }, "Action": "logs:PutLogEvents", "Resource": "logArn", "Condition": { "ArnLike":
	// { "aws:SourceArn": "myRoute53ResourceArn" }, "StringEquals": { "aws:SourceAccount":
	// "myAwsAccountId" } } } ] }
	PolicyDocument *string `locationName:"policyDocument" min:"1" type:"string"`

	// Name of the new policy. This parameter is required.
	PolicyName *string `locationName:"policyName" type:"string"`
	// contains filtered or unexported fields
}

func (PutResourcePolicyInput) GoString added in v1.10.41

func (s PutResourcePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutResourcePolicyInput) SetPolicyDocument added in v1.10.41

func (s *PutResourcePolicyInput) SetPolicyDocument(v string) *PutResourcePolicyInput

SetPolicyDocument sets the PolicyDocument field's value.

func (*PutResourcePolicyInput) SetPolicyName added in v1.10.41

SetPolicyName sets the PolicyName field's value.

func (PutResourcePolicyInput) String added in v1.10.41

func (s PutResourcePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutResourcePolicyInput) Validate added in v1.10.41

func (s *PutResourcePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutResourcePolicyOutput added in v1.10.41

type PutResourcePolicyOutput struct {

	// The new policy.
	ResourcePolicy *ResourcePolicy `locationName:"resourcePolicy" type:"structure"`
	// contains filtered or unexported fields
}

func (PutResourcePolicyOutput) GoString added in v1.10.41

func (s PutResourcePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutResourcePolicyOutput) SetResourcePolicy added in v1.10.41

SetResourcePolicy sets the ResourcePolicy field's value.

func (PutResourcePolicyOutput) String added in v1.10.41

func (s PutResourcePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutRetentionPolicyInput

type PutRetentionPolicyInput struct {

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`

	// 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
	// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html).
	//
	// RetentionInDays is a required field
	RetentionInDays *int64 `locationName:"retentionInDays" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (PutRetentionPolicyInput) GoString added in v0.6.5

func (s PutRetentionPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRetentionPolicyInput) SetLogGroupName added in v1.5.0

SetLogGroupName sets the LogGroupName field's value.

func (*PutRetentionPolicyInput) SetRetentionInDays added in v1.5.0

func (s *PutRetentionPolicyInput) SetRetentionInDays(v int64) *PutRetentionPolicyInput

SetRetentionInDays sets the RetentionInDays field's value.

func (PutRetentionPolicyInput) String added in v0.6.5

func (s PutRetentionPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRetentionPolicyInput) Validate added in v1.1.21

func (s *PutRetentionPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutRetentionPolicyOutput

type PutRetentionPolicyOutput struct {
	// contains filtered or unexported fields
}

func (PutRetentionPolicyOutput) GoString added in v0.6.5

func (s PutRetentionPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutRetentionPolicyOutput) String added in v0.6.5

func (s PutRetentionPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutSubscriptionFilterInput added in v0.6.1

type PutSubscriptionFilterInput struct {

	// The ARN of the destination to deliver matching log events to. Currently,
	// the supported destinations are:
	//
	//    * An Amazon Kinesis stream belonging to the same account as the subscription
	//    filter, for same-account delivery.
	//
	//    * A logical destination (specified using an ARN) belonging to a different
	//    account, for cross-account delivery. If you're setting up a cross-account
	//    subscription, the destination must have an IAM policy associated with
	//    it. The IAM policy must allow the sender to send logs to the destination.
	//    For more information, see PutDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html).
	//
	//    * A Kinesis Data Firehose delivery stream belonging to the same account
	//    as the subscription filter, for same-account delivery.
	//
	//    * A Lambda function belonging to the same account as the subscription
	//    filter, for same-account delivery.
	//
	// DestinationArn is a required field
	DestinationArn *string `locationName:"destinationArn" min:"1" type:"string" required:"true"`

	// The method used to distribute log data to the destination. By default, log
	// data is grouped by log stream, but the grouping can be set to random for
	// a more even distribution. This property is only applicable when the destination
	// is an Amazon Kinesis data stream.
	Distribution *string `locationName:"distribution" type:"string" enum:"Distribution"`

	// A name for the subscription filter. If you are updating an existing filter,
	// you must specify the correct name in filterName. To find the name of the
	// filter currently associated with a log group, use DescribeSubscriptionFilters
	// (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeSubscriptionFilters.html).
	//
	// FilterName is a required field
	FilterName *string `locationName:"filterName" min:"1" type:"string" required:"true"`

	// A filter pattern for subscribing to a filtered stream of log events.
	//
	// FilterPattern is a required field
	FilterPattern *string `locationName:"filterPattern" type:"string" required:"true"`

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`

	// The ARN of an IAM role that grants CloudWatch Logs permissions to deliver
	// ingested log events to the destination stream. You don't need to provide
	// the ARN when you are working with a logical destination for cross-account
	// delivery.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutSubscriptionFilterInput) GoString added in v0.6.5

func (s PutSubscriptionFilterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutSubscriptionFilterInput) SetDestinationArn added in v1.5.0

SetDestinationArn sets the DestinationArn field's value.

func (*PutSubscriptionFilterInput) SetDistribution added in v1.6.3

SetDistribution sets the Distribution field's value.

func (*PutSubscriptionFilterInput) SetFilterName added in v1.5.0

SetFilterName sets the FilterName field's value.

func (*PutSubscriptionFilterInput) SetFilterPattern added in v1.5.0

SetFilterPattern sets the FilterPattern field's value.

func (*PutSubscriptionFilterInput) SetLogGroupName added in v1.5.0

SetLogGroupName sets the LogGroupName field's value.

func (*PutSubscriptionFilterInput) SetRoleArn added in v1.5.0

SetRoleArn sets the RoleArn field's value.

func (PutSubscriptionFilterInput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutSubscriptionFilterInput) Validate added in v1.1.21

func (s *PutSubscriptionFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutSubscriptionFilterOutput added in v0.6.1

type PutSubscriptionFilterOutput struct {
	// contains filtered or unexported fields
}

func (PutSubscriptionFilterOutput) GoString added in v0.6.5

func (s PutSubscriptionFilterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutSubscriptionFilterOutput) String added in v0.6.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryCompileError added in v1.15.84

type QueryCompileError struct {

	// Reserved.
	Location *QueryCompileErrorLocation `locationName:"location" type:"structure"`

	// Reserved.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Reserved.

func (QueryCompileError) GoString added in v1.15.84

func (s QueryCompileError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryCompileError) SetLocation added in v1.15.84

SetLocation sets the Location field's value.

func (*QueryCompileError) SetMessage added in v1.15.84

func (s *QueryCompileError) SetMessage(v string) *QueryCompileError

SetMessage sets the Message field's value.

func (QueryCompileError) String added in v1.15.84

func (s QueryCompileError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryCompileErrorLocation added in v1.15.84

type QueryCompileErrorLocation struct {

	// Reserved.
	EndCharOffset *int64 `locationName:"endCharOffset" type:"integer"`

	// Reserved.
	StartCharOffset *int64 `locationName:"startCharOffset" type:"integer"`
	// contains filtered or unexported fields
}

Reserved.

func (QueryCompileErrorLocation) GoString added in v1.15.84

func (s QueryCompileErrorLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryCompileErrorLocation) SetEndCharOffset added in v1.15.84

SetEndCharOffset sets the EndCharOffset field's value.

func (*QueryCompileErrorLocation) SetStartCharOffset added in v1.15.84

func (s *QueryCompileErrorLocation) SetStartCharOffset(v int64) *QueryCompileErrorLocation

SetStartCharOffset sets the StartCharOffset field's value.

func (QueryCompileErrorLocation) String added in v1.15.84

func (s QueryCompileErrorLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryDefinition added in v1.30.23

type QueryDefinition struct {

	// The date that the query definition was most recently modified.
	LastModified *int64 `locationName:"lastModified" type:"long"`

	// If this query definition contains a list of log groups that it is limited
	// to, that list appears here.
	LogGroupNames []*string `locationName:"logGroupNames" type:"list"`

	// The name of the query definition.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The unique ID of the query definition.
	QueryDefinitionId *string `locationName:"queryDefinitionId" type:"string"`

	// The query string to use for this definition. For more information, see CloudWatch
	// Logs Insights Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).
	QueryString *string `locationName:"queryString" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (QueryDefinition) GoString added in v1.30.23

func (s QueryDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryDefinition) SetLastModified added in v1.30.23

func (s *QueryDefinition) SetLastModified(v int64) *QueryDefinition

SetLastModified sets the LastModified field's value.

func (*QueryDefinition) SetLogGroupNames added in v1.30.23

func (s *QueryDefinition) SetLogGroupNames(v []*string) *QueryDefinition

SetLogGroupNames sets the LogGroupNames field's value.

func (*QueryDefinition) SetName added in v1.30.23

func (s *QueryDefinition) SetName(v string) *QueryDefinition

SetName sets the Name field's value.

func (*QueryDefinition) SetQueryDefinitionId added in v1.30.23

func (s *QueryDefinition) SetQueryDefinitionId(v string) *QueryDefinition

SetQueryDefinitionId sets the QueryDefinitionId field's value.

func (*QueryDefinition) SetQueryString added in v1.30.23

func (s *QueryDefinition) SetQueryString(v string) *QueryDefinition

SetQueryString sets the QueryString field's value.

func (QueryDefinition) String added in v1.30.23

func (s QueryDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryInfo added in v1.15.84

type QueryInfo struct {

	// The date and time that this query was created.
	CreateTime *int64 `locationName:"createTime" type:"long"`

	// The name of the log group scanned by this query.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// The unique ID number of this query.
	QueryId *string `locationName:"queryId" type:"string"`

	// The query string used in this query.
	QueryString *string `locationName:"queryString" type:"string"`

	// The status of this query. Possible values are Cancelled, Complete, Failed,
	// Running, Scheduled, and Unknown.
	Status *string `locationName:"status" type:"string" enum:"QueryStatus"`
	// contains filtered or unexported fields
}

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

func (QueryInfo) GoString added in v1.15.84

func (s QueryInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryInfo) SetCreateTime added in v1.15.84

func (s *QueryInfo) SetCreateTime(v int64) *QueryInfo

SetCreateTime sets the CreateTime field's value.

func (*QueryInfo) SetLogGroupName added in v1.15.84

func (s *QueryInfo) SetLogGroupName(v string) *QueryInfo

SetLogGroupName sets the LogGroupName field's value.

func (*QueryInfo) SetQueryId added in v1.15.84

func (s *QueryInfo) SetQueryId(v string) *QueryInfo

SetQueryId sets the QueryId field's value.

func (*QueryInfo) SetQueryString added in v1.15.84

func (s *QueryInfo) SetQueryString(v string) *QueryInfo

SetQueryString sets the QueryString field's value.

func (*QueryInfo) SetStatus added in v1.15.84

func (s *QueryInfo) SetStatus(v string) *QueryInfo

SetStatus sets the Status field's value.

func (QueryInfo) String added in v1.15.84

func (s QueryInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryStatistics added in v1.15.84

type QueryStatistics struct {

	// The total number of bytes in the log events scanned during the query.
	BytesScanned *float64 `locationName:"bytesScanned" type:"double"`

	// The number of log events that matched the query string.
	RecordsMatched *float64 `locationName:"recordsMatched" type:"double"`

	// The total number of log events scanned during the query.
	RecordsScanned *float64 `locationName:"recordsScanned" type:"double"`
	// 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.

func (QueryStatistics) GoString added in v1.15.84

func (s QueryStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryStatistics) SetBytesScanned added in v1.15.84

func (s *QueryStatistics) SetBytesScanned(v float64) *QueryStatistics

SetBytesScanned sets the BytesScanned field's value.

func (*QueryStatistics) SetRecordsMatched added in v1.15.84

func (s *QueryStatistics) SetRecordsMatched(v float64) *QueryStatistics

SetRecordsMatched sets the RecordsMatched field's value.

func (*QueryStatistics) SetRecordsScanned added in v1.15.84

func (s *QueryStatistics) SetRecordsScanned(v float64) *QueryStatistics

SetRecordsScanned sets the RecordsScanned field's value.

func (QueryStatistics) String added in v1.15.84

func (s QueryStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RejectedLogEventsInfo

type RejectedLogEventsInfo struct {

	// The expired log events.
	ExpiredLogEventEndIndex *int64 `locationName:"expiredLogEventEndIndex" type:"integer"`

	// The index of the first log event that is too new. This field is inclusive.
	TooNewLogEventStartIndex *int64 `locationName:"tooNewLogEventStartIndex" type:"integer"`

	// The index of the last log event that is too old. This field is exclusive.
	TooOldLogEventEndIndex *int64 `locationName:"tooOldLogEventEndIndex" type:"integer"`
	// contains filtered or unexported fields
}

Represents the rejected events.

func (RejectedLogEventsInfo) GoString added in v0.6.5

func (s RejectedLogEventsInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RejectedLogEventsInfo) SetExpiredLogEventEndIndex added in v1.5.0

func (s *RejectedLogEventsInfo) SetExpiredLogEventEndIndex(v int64) *RejectedLogEventsInfo

SetExpiredLogEventEndIndex sets the ExpiredLogEventEndIndex field's value.

func (*RejectedLogEventsInfo) SetTooNewLogEventStartIndex added in v1.5.0

func (s *RejectedLogEventsInfo) SetTooNewLogEventStartIndex(v int64) *RejectedLogEventsInfo

SetTooNewLogEventStartIndex sets the TooNewLogEventStartIndex field's value.

func (*RejectedLogEventsInfo) SetTooOldLogEventEndIndex added in v1.5.0

func (s *RejectedLogEventsInfo) SetTooOldLogEventEndIndex(v int64) *RejectedLogEventsInfo

SetTooOldLogEventEndIndex sets the TooOldLogEventEndIndex field's value.

func (RejectedLogEventsInfo) String added in v0.6.5

func (s RejectedLogEventsInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceAlreadyExistsException added in v1.28.0

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource already exists.

func (*ResourceAlreadyExistsException) Code added in v1.28.0

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error added in v1.28.0

func (ResourceAlreadyExistsException) GoString added in v1.28.0

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistsException) Message added in v1.28.0

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID added in v1.28.0

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode added in v1.28.0

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String added in v1.28.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource does not exist.

func (*ResourceNotFoundException) Code added in v1.28.0

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourcePolicy added in v1.10.41

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 `locationName:"lastUpdatedTime" type:"long"`

	// The details of the policy.
	PolicyDocument *string `locationName:"policyDocument" min:"1" type:"string"`

	// The name of the resource policy.
	PolicyName *string `locationName:"policyName" type:"string"`
	// contains filtered or unexported fields
}

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

func (ResourcePolicy) GoString added in v1.10.41

func (s ResourcePolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourcePolicy) SetLastUpdatedTime added in v1.10.41

func (s *ResourcePolicy) SetLastUpdatedTime(v int64) *ResourcePolicy

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*ResourcePolicy) SetPolicyDocument added in v1.10.41

func (s *ResourcePolicy) SetPolicyDocument(v string) *ResourcePolicy

SetPolicyDocument sets the PolicyDocument field's value.

func (*ResourcePolicy) SetPolicyName added in v1.10.41

func (s *ResourcePolicy) SetPolicyName(v string) *ResourcePolicy

SetPolicyName sets the PolicyName field's value.

func (ResourcePolicy) String added in v1.10.41

func (s ResourcePolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResultField added in v1.15.84

type ResultField struct {

	// The log event field.
	Field *string `locationName:"field" type:"string"`

	// The value of this field.
	Value *string `locationName:"value" type:"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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html).

func (ResultField) GoString added in v1.15.84

func (s ResultField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResultField) SetField added in v1.15.84

func (s *ResultField) SetField(v string) *ResultField

SetField sets the Field field's value.

func (*ResultField) SetValue added in v1.15.84

func (s *ResultField) SetValue(v string) *ResultField

SetValue sets the Value field's value.

func (ResultField) String added in v1.15.84

func (s ResultField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SearchedLogStream

type SearchedLogStream struct {

	// The name of the log stream.
	LogStreamName *string `locationName:"logStreamName" min:"1" type:"string"`

	// Indicates whether all the events in this log stream were searched.
	SearchedCompletely *bool `locationName:"searchedCompletely" type:"boolean"`
	// contains filtered or unexported fields
}

Represents the search status of a log stream.

func (SearchedLogStream) GoString added in v0.6.5

func (s SearchedLogStream) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SearchedLogStream) SetLogStreamName added in v1.5.0

func (s *SearchedLogStream) SetLogStreamName(v string) *SearchedLogStream

SetLogStreamName sets the LogStreamName field's value.

func (*SearchedLogStream) SetSearchedCompletely added in v1.5.0

func (s *SearchedLogStream) SetSearchedCompletely(v bool) *SearchedLogStream

SetSearchedCompletely sets the SearchedCompletely field's value.

func (SearchedLogStream) String added in v0.6.5

func (s SearchedLogStream) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException added in v1.47.8

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This request exceeds a service quota.

func (*ServiceQuotaExceededException) Code added in v1.47.8

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error added in v1.47.8

func (ServiceQuotaExceededException) GoString added in v1.47.8

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message added in v1.47.8

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr added in v1.47.8

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID added in v1.47.8

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode added in v1.47.8

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String added in v1.47.8

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceUnavailableException added in v1.28.0

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The service cannot complete the request.

func (*ServiceUnavailableException) Code added in v1.28.0

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.28.0

func (ServiceUnavailableException) GoString added in v1.28.0

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableException) Message added in v1.28.0

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.28.0

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.28.0

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.28.0

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String added in v1.28.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SessionStreamingException added in v1.49.1

type SessionStreamingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*SessionStreamingException) Code added in v1.49.1

Code returns the exception type name.

func (*SessionStreamingException) Error added in v1.49.1

func (s *SessionStreamingException) Error() string

func (SessionStreamingException) GoString added in v1.49.1

func (s SessionStreamingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionStreamingException) MarshalEvent added in v1.49.1

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*SessionStreamingException) Message added in v1.49.1

func (s *SessionStreamingException) Message() string

Message returns the exception's message.

func (*SessionStreamingException) OrigErr added in v1.49.1

func (s *SessionStreamingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SessionStreamingException) RequestID added in v1.49.1

func (s *SessionStreamingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SessionStreamingException) StatusCode added in v1.49.1

func (s *SessionStreamingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (SessionStreamingException) String added in v1.49.1

func (s SessionStreamingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionStreamingException) UnmarshalEvent added in v1.49.1

func (s *SessionStreamingException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the SessionStreamingException value. This method is only used internally within the SDK's EventStream handling.

type SessionTimeoutException added in v1.49.1

type SessionTimeoutException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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) Code added in v1.49.1

func (s *SessionTimeoutException) Code() string

Code returns the exception type name.

func (*SessionTimeoutException) Error added in v1.49.1

func (s *SessionTimeoutException) Error() string

func (SessionTimeoutException) GoString added in v1.49.1

func (s SessionTimeoutException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionTimeoutException) MarshalEvent added in v1.49.1

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*SessionTimeoutException) Message added in v1.49.1

func (s *SessionTimeoutException) Message() string

Message returns the exception's message.

func (*SessionTimeoutException) OrigErr added in v1.49.1

func (s *SessionTimeoutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SessionTimeoutException) RequestID added in v1.49.1

func (s *SessionTimeoutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SessionTimeoutException) StatusCode added in v1.49.1

func (s *SessionTimeoutException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (SessionTimeoutException) String added in v1.49.1

func (s SessionTimeoutException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SessionTimeoutException) UnmarshalEvent added in v1.49.1

func (s *SessionTimeoutException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the SessionTimeoutException value. This method is only used internally within the SDK's EventStream handling.

type StartLiveTailEventStream added in v1.49.1

type StartLiveTailEventStream struct {

	// Reader is the EventStream reader for the StartLiveTailResponseStream
	// events. This value is automatically set by the SDK when the API call is made
	// Use this member when unit testing your code with the SDK to mock out the
	// EventStream Reader.
	//
	// Must not be nil.
	Reader StartLiveTailResponseStreamReader
	// contains filtered or unexported fields
}

StartLiveTailEventStream provides the event stream handling for the StartLiveTail.

For testing and mocking the event stream this type should be initialized via the NewStartLiveTailEventStream constructor function. Using the functional options to pass in nested mock behavior.

func NewStartLiveTailEventStream added in v1.49.1

func NewStartLiveTailEventStream(opts ...func(*StartLiveTailEventStream)) *StartLiveTailEventStream

NewStartLiveTailEventStream initializes an StartLiveTailEventStream. This function should only be used for testing and mocking the StartLiveTailEventStream stream within your application.

The Reader member must be set before reading events from the stream.

es := NewStartLiveTailEventStream(func(o *StartLiveTailEventStream){
    es.Reader = myMockStreamReader
})

func (*StartLiveTailEventStream) Close added in v1.49.1

func (es *StartLiveTailEventStream) Close() (err error)

Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.

You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.

func (*StartLiveTailEventStream) Err added in v1.49.1

func (es *StartLiveTailEventStream) Err() error

Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.

func (*StartLiveTailEventStream) Events added in v1.49.1

Events returns a channel to read events from.

These events are:

  • LiveTailSessionStart
  • LiveTailSessionUpdate
  • StartLiveTailResponseStreamUnknownEvent

type StartLiveTailInput added in v1.49.1

type StartLiveTailInput struct {

	// An optional pattern to use to filter the results to include only log events
	// that match the pattern. For example, a filter pattern of error 404 causes
	// only log events that include both error and 404 to be included in the Live
	// Tail stream.
	//
	// Regular expression filter patterns are supported.
	//
	// For more information about filter pattern syntax, see Filter and Pattern
	// Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).
	LogEventFilterPattern *string `locationName:"logEventFilterPattern" type:"string"`

	// An array where each item in the array is a log group to include in the Live
	// Tail session.
	//
	// Specify each log group by its ARN.
	//
	// If you specify an ARN, the ARN can't end with an asterisk (*).
	//
	// You can include up to 10 log groups.
	//
	// LogGroupIdentifiers is a required field
	LogGroupIdentifiers []*string `locationName:"logGroupIdentifiers" min:"1" type:"list" required:"true"`

	// If you specify this parameter, then only log events in the log streams that
	// have names that start with the prefixes that you specify here are included
	// in the Live Tail session.
	//
	// If you specify this field, you can't also specify the logStreamNames field.
	//
	// You can specify this parameter only if you specify only one log group in
	// logGroupIdentifiers.
	LogStreamNamePrefixes []*string `locationName:"logStreamNamePrefixes" min:"1" type:"list"`

	// If you specify this parameter, then only log events in the log streams that
	// you specify here are included in the Live Tail session.
	//
	// If you specify this field, you can't also specify the logStreamNamePrefixes
	// field.
	//
	// You can specify this parameter only if you specify only one log group in
	// logGroupIdentifiers.
	LogStreamNames []*string `locationName:"logStreamNames" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (StartLiveTailInput) GoString added in v1.49.1

func (s StartLiveTailInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartLiveTailInput) SetLogEventFilterPattern added in v1.49.1

func (s *StartLiveTailInput) SetLogEventFilterPattern(v string) *StartLiveTailInput

SetLogEventFilterPattern sets the LogEventFilterPattern field's value.

func (*StartLiveTailInput) SetLogGroupIdentifiers added in v1.49.1

func (s *StartLiveTailInput) SetLogGroupIdentifiers(v []*string) *StartLiveTailInput

SetLogGroupIdentifiers sets the LogGroupIdentifiers field's value.

func (*StartLiveTailInput) SetLogStreamNamePrefixes added in v1.49.1

func (s *StartLiveTailInput) SetLogStreamNamePrefixes(v []*string) *StartLiveTailInput

SetLogStreamNamePrefixes sets the LogStreamNamePrefixes field's value.

func (*StartLiveTailInput) SetLogStreamNames added in v1.49.1

func (s *StartLiveTailInput) SetLogStreamNames(v []*string) *StartLiveTailInput

SetLogStreamNames sets the LogStreamNames field's value.

func (StartLiveTailInput) String added in v1.49.1

func (s StartLiveTailInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartLiveTailInput) Validate added in v1.49.1

func (s *StartLiveTailInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartLiveTailOutput added in v1.49.1

type StartLiveTailOutput struct {
	// contains filtered or unexported fields
}

func (*StartLiveTailOutput) GetStream added in v1.49.1

GetStream returns the type to interact with the event stream.

func (StartLiveTailOutput) GoString added in v1.49.1

func (s StartLiveTailOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartLiveTailOutput) MarshalEvent added in v1.49.1

func (s *StartLiveTailOutput) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (StartLiveTailOutput) String added in v1.49.1

func (s StartLiveTailOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartLiveTailOutput) UnmarshalEvent added in v1.49.1

func (s *StartLiveTailOutput) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the StartLiveTailOutput value. This method is only used internally within the SDK's EventStream handling.

type StartLiveTailResponseStreamEvent added in v1.49.1

type StartLiveTailResponseStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

StartLiveTailResponseStreamEvent groups together all EventStream events writes for StartLiveTailResponseStream.

These events are:

  • LiveTailSessionStart
  • LiveTailSessionUpdate

type StartLiveTailResponseStreamReader added in v1.49.1

type StartLiveTailResponseStreamReader interface {
	// Returns a channel of events as they are read from the event stream.
	Events() <-chan StartLiveTailResponseStreamEvent

	// Close will stop the reader reading events from the stream.
	Close() error

	// Returns any error that has occurred while reading from the event stream.
	Err() error
}

StartLiveTailResponseStreamReader provides the interface for reading to the stream. The default implementation for this interface will be StartLiveTailResponseStream.

The reader's Close method must allow multiple concurrent calls.

These events are:

  • LiveTailSessionStart
  • LiveTailSessionUpdate
  • StartLiveTailResponseStreamUnknownEvent

type StartLiveTailResponseStreamUnknownEvent added in v1.49.1

type StartLiveTailResponseStreamUnknownEvent struct {
	Type    string
	Message eventstream.Message
}

StartLiveTailResponseStreamUnknownEvent provides a failsafe event for the StartLiveTailResponseStream group of events when an unknown event is received.

func (*StartLiveTailResponseStreamUnknownEvent) MarshalEvent added in v1.49.1

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*StartLiveTailResponseStreamUnknownEvent) UnmarshalEvent added in v1.49.1

func (e *StartLiveTailResponseStreamUnknownEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the StartLiveTailResponseStream value. This method is only used internally within the SDK's EventStream handling.

type StartQueryInput added in v1.15.84

type StartQueryInput struct {

	// The end of the time range to query. The range is inclusive, so the specified
	// end time is included in the query. Specified as epoch time, the number of
	// seconds since January 1, 1970, 00:00:00 UTC.
	//
	// EndTime is a required field
	EndTime *int64 `locationName:"endTime" type:"long" required:"true"`

	// The maximum number of log events to return in the query. If the query string
	// uses the fields command, only the specified fields and their values are returned.
	// The default is 1000.
	Limit *int64 `locationName:"limit" min:"1" type:"integer"`

	// The list of log groups to query. You can include up to 50 log groups.
	//
	// You can specify them by the log group name or ARN. If a log group that you're
	// querying is in a source account and you're using a monitoring account, you
	// must specify the ARN of the log group here. The query definition must also
	// be defined in the monitoring account.
	//
	// If you specify an ARN, the ARN can't end with an asterisk (*).
	//
	// A StartQuery operation must include exactly one of the following parameters:
	// logGroupName, logGroupNames, or logGroupIdentifiers.
	LogGroupIdentifiers []*string `locationName:"logGroupIdentifiers" type:"list"`

	// The log group on which to perform the query.
	//
	// A StartQuery operation must include exactly one of the following parameters:
	// logGroupName, logGroupNames, or logGroupIdentifiers.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	// The list of log groups to be queried. You can include up to 50 log groups.
	//
	// A StartQuery operation must include exactly one of the following parameters:
	// logGroupName, logGroupNames, or logGroupIdentifiers.
	LogGroupNames []*string `locationName:"logGroupNames" type:"list"`

	// The query string to use. For more information, see CloudWatch Logs Insights
	// Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).
	//
	// QueryString is a required field
	QueryString *string `locationName:"queryString" type:"string" required:"true"`

	// The beginning of the time range to query. The range is inclusive, so the
	// specified start time is included in the query. Specified as epoch time, the
	// number of seconds since January 1, 1970, 00:00:00 UTC.
	//
	// StartTime is a required field
	StartTime *int64 `locationName:"startTime" type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (StartQueryInput) GoString added in v1.15.84

func (s StartQueryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartQueryInput) SetEndTime added in v1.15.84

func (s *StartQueryInput) SetEndTime(v int64) *StartQueryInput

SetEndTime sets the EndTime field's value.

func (*StartQueryInput) SetLimit added in v1.15.84

func (s *StartQueryInput) SetLimit(v int64) *StartQueryInput

SetLimit sets the Limit field's value.

func (*StartQueryInput) SetLogGroupIdentifiers added in v1.44.146

func (s *StartQueryInput) SetLogGroupIdentifiers(v []*string) *StartQueryInput

SetLogGroupIdentifiers sets the LogGroupIdentifiers field's value.

func (*StartQueryInput) SetLogGroupName added in v1.15.84

func (s *StartQueryInput) SetLogGroupName(v string) *StartQueryInput

SetLogGroupName sets the LogGroupName field's value.

func (*StartQueryInput) SetLogGroupNames added in v1.21.6

func (s *StartQueryInput) SetLogGroupNames(v []*string) *StartQueryInput

SetLogGroupNames sets the LogGroupNames field's value.

func (*StartQueryInput) SetQueryString added in v1.15.84

func (s *StartQueryInput) SetQueryString(v string) *StartQueryInput

SetQueryString sets the QueryString field's value.

func (*StartQueryInput) SetStartTime added in v1.15.84

func (s *StartQueryInput) SetStartTime(v int64) *StartQueryInput

SetStartTime sets the StartTime field's value.

func (StartQueryInput) String added in v1.15.84

func (s StartQueryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartQueryInput) Validate added in v1.15.84

func (s *StartQueryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartQueryOutput added in v1.15.84

type StartQueryOutput struct {

	// The unique ID of the query.
	QueryId *string `locationName:"queryId" type:"string"`
	// contains filtered or unexported fields
}

func (StartQueryOutput) GoString added in v1.15.84

func (s StartQueryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartQueryOutput) SetQueryId added in v1.15.84

func (s *StartQueryOutput) SetQueryId(v string) *StartQueryOutput

SetQueryId sets the QueryId field's value.

func (StartQueryOutput) String added in v1.15.84

func (s StartQueryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopQueryInput added in v1.15.84

type StopQueryInput struct {

	// The ID number of the query to stop. To find this ID number, use DescribeQueries.
	//
	// QueryId is a required field
	QueryId *string `locationName:"queryId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopQueryInput) GoString added in v1.15.84

func (s StopQueryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopQueryInput) SetQueryId added in v1.15.84

func (s *StopQueryInput) SetQueryId(v string) *StopQueryInput

SetQueryId sets the QueryId field's value.

func (StopQueryInput) String added in v1.15.84

func (s StopQueryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopQueryInput) Validate added in v1.15.84

func (s *StopQueryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopQueryOutput added in v1.15.84

type StopQueryOutput struct {

	// This is true if the query was stopped by the StopQuery operation.
	Success *bool `locationName:"success" type:"boolean"`
	// contains filtered or unexported fields
}

func (StopQueryOutput) GoString added in v1.15.84

func (s StopQueryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopQueryOutput) SetSuccess added in v1.15.84

func (s *StopQueryOutput) SetSuccess(v bool) *StopQueryOutput

SetSuccess sets the Success field's value.

func (StopQueryOutput) String added in v1.15.84

func (s StopQueryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SubscriptionFilter added in v0.6.1

type SubscriptionFilter struct {

	// The creation time of the subscription filter, expressed as the number of
	// milliseconds after Jan 1, 1970 00:00:00 UTC.
	CreationTime *int64 `locationName:"creationTime" type:"long"`

	// The Amazon Resource Name (ARN) of the destination.
	DestinationArn *string `locationName:"destinationArn" min:"1" type:"string"`

	// The method used to distribute log data to the destination, which can be either
	// random or grouped by log stream.
	Distribution *string `locationName:"distribution" type:"string" enum:"Distribution"`

	// The name of the subscription filter.
	FilterName *string `locationName:"filterName" min:"1" type:"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 `locationName:"filterPattern" type:"string"`

	// The name of the log group.
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`

	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a subscription filter.

func (SubscriptionFilter) GoString added in v0.6.5

func (s SubscriptionFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubscriptionFilter) SetCreationTime added in v1.5.0

func (s *SubscriptionFilter) SetCreationTime(v int64) *SubscriptionFilter

SetCreationTime sets the CreationTime field's value.

func (*SubscriptionFilter) SetDestinationArn added in v1.5.0

func (s *SubscriptionFilter) SetDestinationArn(v string) *SubscriptionFilter

SetDestinationArn sets the DestinationArn field's value.

func (*SubscriptionFilter) SetDistribution added in v1.6.3

func (s *SubscriptionFilter) SetDistribution(v string) *SubscriptionFilter

SetDistribution sets the Distribution field's value.

func (*SubscriptionFilter) SetFilterName added in v1.5.0

func (s *SubscriptionFilter) SetFilterName(v string) *SubscriptionFilter

SetFilterName sets the FilterName field's value.

func (*SubscriptionFilter) SetFilterPattern added in v1.5.0

func (s *SubscriptionFilter) SetFilterPattern(v string) *SubscriptionFilter

SetFilterPattern sets the FilterPattern field's value.

func (*SubscriptionFilter) SetLogGroupName added in v1.5.0

func (s *SubscriptionFilter) SetLogGroupName(v string) *SubscriptionFilter

SetLogGroupName sets the LogGroupName field's value.

func (*SubscriptionFilter) SetRoleArn added in v1.5.0

func (s *SubscriptionFilter) SetRoleArn(v string) *SubscriptionFilter

SetRoleArn sets the RoleArn field's value.

func (SubscriptionFilter) String added in v0.6.5

func (s SubscriptionFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SuppressionPeriod added in v1.48.4

type SuppressionPeriod struct {

	// Specifies whether the value of value is in seconds, minutes, or hours.
	SuppressionUnit *string `locationName:"suppressionUnit" type:"string" enum:"SuppressionUnit"`

	// Specifies the number of seconds, minutes or hours to suppress this anomaly.
	// There is no maximum.
	Value *int64 `locationName:"value" type:"integer"`
	// contains filtered or unexported fields
}

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

func (SuppressionPeriod) GoString added in v1.48.4

func (s SuppressionPeriod) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuppressionPeriod) SetSuppressionUnit added in v1.48.4

func (s *SuppressionPeriod) SetSuppressionUnit(v string) *SuppressionPeriod

SetSuppressionUnit sets the SuppressionUnit field's value.

func (*SuppressionPeriod) SetValue added in v1.48.4

func (s *SuppressionPeriod) SetValue(v int64) *SuppressionPeriod

SetValue sets the Value field's value.

func (SuppressionPeriod) String added in v1.48.4

func (s SuppressionPeriod) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagLogGroupInput deprecated added in v1.6.3

type TagLogGroupInput struct {

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`

	// The key-value pairs to use for the tags.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

Deprecated: Please use the generic tagging API model TagResourceRequest

func (TagLogGroupInput) GoString added in v1.6.3

func (s TagLogGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagLogGroupInput) SetLogGroupName added in v1.6.3

func (s *TagLogGroupInput) SetLogGroupName(v string) *TagLogGroupInput

SetLogGroupName sets the LogGroupName field's value.

func (*TagLogGroupInput) SetTags added in v1.6.3

func (s *TagLogGroupInput) SetTags(v map[string]*string) *TagLogGroupInput

SetTags sets the Tags field's value.

func (TagLogGroupInput) String added in v1.6.3

func (s TagLogGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagLogGroupInput) Validate added in v1.6.3

func (s *TagLogGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagLogGroupOutput added in v1.6.3

type TagLogGroupOutput struct {
	// contains filtered or unexported fields
}

func (TagLogGroupOutput) GoString added in v1.6.3

func (s TagLogGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagLogGroupOutput) String added in v1.6.3

func (s TagLogGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput added in v1.44.127

type TagResourceInput struct {

	// The ARN of the resource that you're adding tags to.
	//
	// The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name
	//
	// The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name
	//
	// For more information about ARN format, see CloudWatch Logs resources and
	// operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html).
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The list of key-value pairs to associate with the resource.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.44.127

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.44.127

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.44.127

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.44.127

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.44.127

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.44.127

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.44.127

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.44.127

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TestMetricFilterInput

type TestMetricFilterInput struct {

	// 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 is a required field
	FilterPattern *string `locationName:"filterPattern" type:"string" required:"true"`

	// The log event messages to test.
	//
	// LogEventMessages is a required field
	LogEventMessages []*string `locationName:"logEventMessages" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TestMetricFilterInput) GoString added in v0.6.5

func (s TestMetricFilterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestMetricFilterInput) SetFilterPattern added in v1.5.0

func (s *TestMetricFilterInput) SetFilterPattern(v string) *TestMetricFilterInput

SetFilterPattern sets the FilterPattern field's value.

func (*TestMetricFilterInput) SetLogEventMessages added in v1.5.0

func (s *TestMetricFilterInput) SetLogEventMessages(v []*string) *TestMetricFilterInput

SetLogEventMessages sets the LogEventMessages field's value.

func (TestMetricFilterInput) String added in v0.6.5

func (s TestMetricFilterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestMetricFilterInput) Validate added in v1.1.21

func (s *TestMetricFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TestMetricFilterOutput

type TestMetricFilterOutput struct {

	// The matched events.
	Matches []*MetricFilterMatchRecord `locationName:"matches" type:"list"`
	// contains filtered or unexported fields
}

func (TestMetricFilterOutput) GoString added in v0.6.5

func (s TestMetricFilterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestMetricFilterOutput) SetMatches added in v1.5.0

SetMatches sets the Matches field's value.

func (TestMetricFilterOutput) String added in v0.6.5

func (s TestMetricFilterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException added in v1.47.8

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request was throttled because of quota limits.

func (*ThrottlingException) Code added in v1.47.8

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.47.8

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.47.8

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message added in v1.47.8

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.47.8

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.47.8

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.47.8

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.47.8

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyTagsException added in v1.44.127

type TooManyTagsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The name of the resource.
	ResourceName *string `locationName:"resourceName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A resource can have no more than 50 tags.

func (*TooManyTagsException) Code added in v1.44.127

func (s *TooManyTagsException) Code() string

Code returns the exception type name.

func (*TooManyTagsException) Error added in v1.44.127

func (s *TooManyTagsException) Error() string

func (TooManyTagsException) GoString added in v1.44.127

func (s TooManyTagsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyTagsException) Message added in v1.44.127

func (s *TooManyTagsException) Message() string

Message returns the exception's message.

func (*TooManyTagsException) OrigErr added in v1.44.127

func (s *TooManyTagsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTagsException) RequestID added in v1.44.127

func (s *TooManyTagsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTagsException) StatusCode added in v1.44.127

func (s *TooManyTagsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyTagsException) String added in v1.44.127

func (s TooManyTagsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnrecognizedClientException added in v1.28.0

type UnrecognizedClientException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0

Code returns the exception type name.

func (*UnrecognizedClientException) Error added in v1.28.0

func (UnrecognizedClientException) GoString added in v1.28.0

func (s UnrecognizedClientException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnrecognizedClientException) Message added in v1.28.0

func (s *UnrecognizedClientException) Message() string

Message returns the exception's message.

func (*UnrecognizedClientException) OrigErr added in v1.28.0

func (s *UnrecognizedClientException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnrecognizedClientException) RequestID added in v1.28.0

func (s *UnrecognizedClientException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnrecognizedClientException) StatusCode added in v1.28.0

func (s *UnrecognizedClientException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnrecognizedClientException) String added in v1.28.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagLogGroupInput deprecated added in v1.6.3

type UntagLogGroupInput struct {

	// The name of the log group.
	//
	// LogGroupName is a required field
	LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`

	// The tag keys. The corresponding tags are removed from the log group.
	//
	// Tags is a required field
	Tags []*string `locationName:"tags" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Deprecated: Please use the generic tagging API model UntagResourceRequest

func (UntagLogGroupInput) GoString added in v1.6.3

func (s UntagLogGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagLogGroupInput) SetLogGroupName added in v1.6.3

func (s *UntagLogGroupInput) SetLogGroupName(v string) *UntagLogGroupInput

SetLogGroupName sets the LogGroupName field's value.

func (*UntagLogGroupInput) SetTags added in v1.6.3

func (s *UntagLogGroupInput) SetTags(v []*string) *UntagLogGroupInput

SetTags sets the Tags field's value.

func (UntagLogGroupInput) String added in v1.6.3

func (s UntagLogGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagLogGroupInput) Validate added in v1.6.3

func (s *UntagLogGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagLogGroupOutput added in v1.6.3

type UntagLogGroupOutput struct {
	// contains filtered or unexported fields
}

func (UntagLogGroupOutput) GoString added in v1.6.3

func (s UntagLogGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagLogGroupOutput) String added in v1.6.3

func (s UntagLogGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.44.127

type UntagResourceInput struct {

	// The ARN of the CloudWatch Logs resource that you're removing tags from.
	//
	// The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name
	//
	// The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name
	//
	// For more information about ARN format, see CloudWatch Logs resources and
	// operations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html).
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The list of tag keys to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.44.127

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.44.127

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.44.127

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.44.127

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.44.127

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.44.127

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.44.127

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.44.127

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAnomalyInput added in v1.48.4

type UpdateAnomalyInput struct {

	// The ARN of the anomaly detector that this operation is to act on.
	//
	// AnomalyDetectorArn is a required field
	AnomalyDetectorArn *string `locationName:"anomalyDetectorArn" min:"1" type:"string" required:"true"`

	// If you are suppressing or unsuppressing an anomaly, specify its unique ID
	// here. You can find anomaly IDs by using the ListAnomalies (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html)
	// operation.
	AnomalyId *string `locationName:"anomalyId" min:"36" type:"string"`

	// If you are suppressing or unsuppressing an pattern, specify its unique ID
	// here. You can find pattern IDs by using the ListAnomalies (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html)
	// operation.
	PatternId *string `locationName:"patternId" min:"32" type:"string"`

	// If you are temporarily suppressing an anomaly or pattern, use this structure
	// to specify how long the suppression is to last.
	SuppressionPeriod *SuppressionPeriod `locationName:"suppressionPeriod" type:"structure"`

	// Use this to specify whether the suppression to be temporary or infinite.
	// If you specify LIMITED, you must also specify a suppressionPeriod. If you
	// specify INFINITE, any value for suppressionPeriod is ignored.
	SuppressionType *string `locationName:"suppressionType" type:"string" enum:"SuppressionType"`
	// contains filtered or unexported fields
}

func (UpdateAnomalyInput) GoString added in v1.48.4

func (s UpdateAnomalyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAnomalyInput) SetAnomalyDetectorArn added in v1.48.4

func (s *UpdateAnomalyInput) SetAnomalyDetectorArn(v string) *UpdateAnomalyInput

SetAnomalyDetectorArn sets the AnomalyDetectorArn field's value.

func (*UpdateAnomalyInput) SetAnomalyId added in v1.48.4

func (s *UpdateAnomalyInput) SetAnomalyId(v string) *UpdateAnomalyInput

SetAnomalyId sets the AnomalyId field's value.

func (*UpdateAnomalyInput) SetPatternId added in v1.48.4

func (s *UpdateAnomalyInput) SetPatternId(v string) *UpdateAnomalyInput

SetPatternId sets the PatternId field's value.

func (*UpdateAnomalyInput) SetSuppressionPeriod added in v1.48.4

func (s *UpdateAnomalyInput) SetSuppressionPeriod(v *SuppressionPeriod) *UpdateAnomalyInput

SetSuppressionPeriod sets the SuppressionPeriod field's value.

func (*UpdateAnomalyInput) SetSuppressionType added in v1.48.4

func (s *UpdateAnomalyInput) SetSuppressionType(v string) *UpdateAnomalyInput

SetSuppressionType sets the SuppressionType field's value.

func (UpdateAnomalyInput) String added in v1.48.4

func (s UpdateAnomalyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAnomalyInput) Validate added in v1.48.4

func (s *UpdateAnomalyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAnomalyOutput added in v1.48.4

type UpdateAnomalyOutput struct {
	// contains filtered or unexported fields
}

func (UpdateAnomalyOutput) GoString added in v1.48.4

func (s UpdateAnomalyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateAnomalyOutput) String added in v1.48.4

func (s UpdateAnomalyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateLogAnomalyDetectorInput added in v1.48.4

type UpdateLogAnomalyDetectorInput struct {

	// The ARN of the anomaly detector that you want to update.
	//
	// AnomalyDetectorArn is a required field
	AnomalyDetectorArn *string `locationName:"anomalyDetectorArn" min:"1" type:"string" required:"true"`

	// The number of days to use 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. Therefore, if you do not
	// correct the cause of an anomaly during this time, it will be considered normal
	// going forward and will not be detected.
	AnomalyVisibilityTime *int64 `locationName:"anomalyVisibilityTime" min:"7" type:"long"`

	// Use this parameter to pause or restart the anomaly detector.
	//
	// Enabled is a required field
	Enabled *bool `locationName:"enabled" type:"boolean" required:"true"`

	// Specifies how often the anomaly detector runs and look for anomalies. Set
	// this value according to the frequency that the log group receives new logs.
	// For example, if the log group receives new log events every 10 minutes, then
	// setting evaluationFrequency to FIFTEEN_MIN might be appropriate.
	EvaluationFrequency *string `locationName:"evaluationFrequency" type:"string" enum:"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 `locationName:"filterPattern" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateLogAnomalyDetectorInput) GoString added in v1.48.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLogAnomalyDetectorInput) SetAnomalyDetectorArn added in v1.48.4

SetAnomalyDetectorArn sets the AnomalyDetectorArn field's value.

func (*UpdateLogAnomalyDetectorInput) SetAnomalyVisibilityTime added in v1.48.4

func (s *UpdateLogAnomalyDetectorInput) SetAnomalyVisibilityTime(v int64) *UpdateLogAnomalyDetectorInput

SetAnomalyVisibilityTime sets the AnomalyVisibilityTime field's value.

func (*UpdateLogAnomalyDetectorInput) SetEnabled added in v1.48.4

SetEnabled sets the Enabled field's value.

func (*UpdateLogAnomalyDetectorInput) SetEvaluationFrequency added in v1.48.4

SetEvaluationFrequency sets the EvaluationFrequency field's value.

func (*UpdateLogAnomalyDetectorInput) SetFilterPattern added in v1.48.4

SetFilterPattern sets the FilterPattern field's value.

func (UpdateLogAnomalyDetectorInput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLogAnomalyDetectorInput) Validate added in v1.48.4

func (s *UpdateLogAnomalyDetectorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateLogAnomalyDetectorOutput added in v1.48.4

type UpdateLogAnomalyDetectorOutput struct {
	// contains filtered or unexported fields
}

func (UpdateLogAnomalyDetectorOutput) GoString added in v1.48.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateLogAnomalyDetectorOutput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException added in v1.47.8

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

One of the parameters for the request is not valid.

func (*ValidationException) Code added in v1.47.8

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error added in v1.47.8

func (s *ValidationException) Error() string

func (ValidationException) GoString added in v1.47.8

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message added in v1.47.8

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr added in v1.47.8

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID added in v1.47.8

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode added in v1.47.8

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String added in v1.47.8

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package cloudwatchlogsiface provides an interface to enable mocking the Amazon CloudWatch Logs service client for testing your code.
Package cloudwatchlogsiface provides an interface to enable mocking the Amazon CloudWatch Logs service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL