types

package
v1.27.7 Latest Latest
Warning

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

 Go to latest Published: May 16, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient permissions to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type Action 

type Action struct {

	// A configuration for an AWS Lambda channel.
	LambdaConfiguration *LambdaConfiguration

	// A configuration for an Amazon SNS channel.
	SNSConfiguration *SNSConfiguration
	// contains filtered or unexported fields
}

A configuration that specifies the action to perform when anomalies are detected.

type AggregationFunction 

type AggregationFunction string
const (
	AggregationFunctionAvg AggregationFunction = "AVG"
	AggregationFunctionSum AggregationFunction = "SUM"
)

Enum values for AggregationFunction

func (AggregationFunction) Values 

func (AggregationFunction) Values() []AggregationFunction

Values returns all known values for AggregationFunction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Alert 

type Alert struct {

	// Action that will be triggered when there is an alert.
	Action *Action

	// The ARN of the alert.
	AlertArn *string

	// A description of the alert.
	AlertDescription *string

	// The configuration of the alert filters, containing MetricList and
	// DimensionFilter.
	AlertFilters *AlertFilters

	// The name of the alert.
	AlertName *string

	// The minimum severity for an anomaly to trigger the alert.
	AlertSensitivityThreshold int32

	// The status of the alert.
	AlertStatus AlertStatus

	// The type of the alert.
	AlertType AlertType

	// The ARN of the detector to which the alert is attached.
	AnomalyDetectorArn *string

	// The time at which the alert was created.
	CreationTime *time.Time

	// The time at which the alert was last modified.
	LastModificationTime *time.Time
	// contains filtered or unexported fields
}

A configuration for Amazon SNS-integrated notifications.

type AlertFilters added in v1.16.0 

type AlertFilters struct {

	// The list of DimensionFilter objects that are used for dimension-based filtering.
	DimensionFilterList []DimensionFilter

	// The list of measures that you want to get alerts for.
	MetricList []string
	// contains filtered or unexported fields
}

The configuration of the alert filters.

type AlertStatus 

type AlertStatus string
const (
	AlertStatusActive   AlertStatus = "ACTIVE"
	AlertStatusInactive AlertStatus = "INACTIVE"
)

Enum values for AlertStatus

func (AlertStatus) Values 

func (AlertStatus) Values() []AlertStatus

Values returns all known values for AlertStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AlertSummary 

type AlertSummary struct {

	// The ARN of the alert.
	AlertArn *string

	// The name of the alert.
	AlertName *string

	// The minimum severity for an anomaly to trigger the alert.
	AlertSensitivityThreshold int32

	// The status of the alert.
	AlertStatus AlertStatus

	// The type of the alert.
	AlertType AlertType

	// The ARN of the detector to which the alert is attached.
	AnomalyDetectorArn *string

	// The time at which the alert was created.
	CreationTime *time.Time

	// The time at which the alert was last modified.
	LastModificationTime *time.Time

	// The alert's [tags].
	//
	// [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
	Tags map[string]string
	// contains filtered or unexported fields
}

Provides a summary of an alert's configuration.

type AlertType 

type AlertType string
const (
	AlertTypeSns    AlertType = "SNS"
	AlertTypeLambda AlertType = "LAMBDA"
)

Enum values for AlertType

func (AlertType) Values 

func (AlertType) Values() []AlertType

Values returns all known values for AlertType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnomalyDetectionTaskStatus 

type AnomalyDetectionTaskStatus string
const (
	AnomalyDetectionTaskStatusPending          AnomalyDetectionTaskStatus = "PENDING"
	AnomalyDetectionTaskStatusInProgress       AnomalyDetectionTaskStatus = "IN_PROGRESS"
	AnomalyDetectionTaskStatusCompleted        AnomalyDetectionTaskStatus = "COMPLETED"
	AnomalyDetectionTaskStatusFailed           AnomalyDetectionTaskStatus = "FAILED"
	AnomalyDetectionTaskStatusFailedToSchedule AnomalyDetectionTaskStatus = "FAILED_TO_SCHEDULE"
)

Enum values for AnomalyDetectionTaskStatus

func (AnomalyDetectionTaskStatus) Values 

func (AnomalyDetectionTaskStatus) Values() []AnomalyDetectionTaskStatus

Values returns all known values for AnomalyDetectionTaskStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnomalyDetectorConfig 

type AnomalyDetectorConfig struct {

	// The frequency at which the detector analyzes its source data.
	AnomalyDetectorFrequency Frequency
	// contains filtered or unexported fields
}

Contains information about a detector's configuration.

type AnomalyDetectorConfigSummary 

type AnomalyDetectorConfigSummary struct {

	// The interval at which the detector analyzes its source data.
	AnomalyDetectorFrequency Frequency
	// contains filtered or unexported fields
}

Contains information about a detector's configuration.

type AnomalyDetectorDataQualityMetric added in v1.17.0 

type AnomalyDetectorDataQualityMetric struct {

	// An array of DataQualityMetricList objects. Each object in the array contains
	// information about a data quality metric.
	MetricSetDataQualityMetricList []MetricSetDataQualityMetric

	// The start time for the data quality metrics collection.
	StartTimestamp *time.Time
	// contains filtered or unexported fields
}

Aggregated details about the data quality metrics collected for the AnomalyDetectorArn provided in the GetDataQualityMetrics object.

type AnomalyDetectorFailureType added in v1.8.0 

type AnomalyDetectorFailureType string
const (
	AnomalyDetectorFailureTypeActivationFailure         AnomalyDetectorFailureType = "ACTIVATION_FAILURE"
	AnomalyDetectorFailureTypeBackTestActivationFailure AnomalyDetectorFailureType = "BACK_TEST_ACTIVATION_FAILURE"
	AnomalyDetectorFailureTypeDeletionFailure           AnomalyDetectorFailureType = "DELETION_FAILURE"
	AnomalyDetectorFailureTypeDeactivationFailure       AnomalyDetectorFailureType = "DEACTIVATION_FAILURE"
)

Enum values for AnomalyDetectorFailureType

func (AnomalyDetectorFailureType) Values added in v1.8.0 

func (AnomalyDetectorFailureType) Values() []AnomalyDetectorFailureType

Values returns all known values for AnomalyDetectorFailureType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnomalyDetectorStatus 

type AnomalyDetectorStatus string
const (
	AnomalyDetectorStatusActive             AnomalyDetectorStatus = "ACTIVE"
	AnomalyDetectorStatusActivating         AnomalyDetectorStatus = "ACTIVATING"
	AnomalyDetectorStatusDeleting           AnomalyDetectorStatus = "DELETING"
	AnomalyDetectorStatusFailed             AnomalyDetectorStatus = "FAILED"
	AnomalyDetectorStatusInactive           AnomalyDetectorStatus = "INACTIVE"
	AnomalyDetectorStatusLearning           AnomalyDetectorStatus = "LEARNING"
	AnomalyDetectorStatusBackTestActivating AnomalyDetectorStatus = "BACK_TEST_ACTIVATING"
	AnomalyDetectorStatusBackTestActive     AnomalyDetectorStatus = "BACK_TEST_ACTIVE"
	AnomalyDetectorStatusBackTestComplete   AnomalyDetectorStatus = "BACK_TEST_COMPLETE"
	AnomalyDetectorStatusDeactivated        AnomalyDetectorStatus = "DEACTIVATED"
	AnomalyDetectorStatusDeactivating       AnomalyDetectorStatus = "DEACTIVATING"
)

Enum values for AnomalyDetectorStatus

func (AnomalyDetectorStatus) Values 

func (AnomalyDetectorStatus) Values() []AnomalyDetectorStatus

Values returns all known values for AnomalyDetectorStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnomalyDetectorSummary 

type AnomalyDetectorSummary struct {

	// The ARN of the detector.
	AnomalyDetectorArn *string

	// A description of the detector.
	AnomalyDetectorDescription *string

	// The name of the detector.
	AnomalyDetectorName *string

	// The time at which the detector was created.
	CreationTime *time.Time

	// The time at which the detector was last modified.
	LastModificationTime *time.Time

	// The status of detector.
	Status AnomalyDetectorStatus

	// The detector's [tags].
	//
	// [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
	Tags map[string]string
	// contains filtered or unexported fields
}

Contains information about an an anomaly detector.

type AnomalyGroup 

type AnomalyGroup struct {

	// The ID of the anomaly group.
	AnomalyGroupId *string

	// The severity score of the group.
	AnomalyGroupScore *float64

	// The end time for the group.
	EndTime *string

	// A list of measures affected by the anomaly.
	MetricLevelImpactList []MetricLevelImpact

	// The name of the primary affected measure for the group.
	PrimaryMetricName *string

	// The start time for the group.
	StartTime *string
	// contains filtered or unexported fields
}

A group of anomalous metrics

type AnomalyGroupStatistics 

type AnomalyGroupStatistics struct {

	// The start of the time range that was searched.
	EvaluationStartDate *string

	// Statistics for individual metrics within the group.
	ItemizedMetricStatsList []ItemizedMetricStats

	// The number of groups found.
	TotalCount int32
	// contains filtered or unexported fields
}

Aggregated statistics for a group of anomalous metrics.

type AnomalyGroupSummary 

type AnomalyGroupSummary struct {

	// The ID of the anomaly group.
	AnomalyGroupId *string

	// The severity score of the group.
	AnomalyGroupScore *float64

	// The end time for the group.
	EndTime *string

	// The name of the primary affected measure for the group.
	PrimaryMetricName *string

	// The start time for the group.
	StartTime *string
	// contains filtered or unexported fields
}

Details about a group of anomalous metrics.

type AnomalyGroupTimeSeries 

type AnomalyGroupTimeSeries struct {

	// The ID of the anomaly group.
	//
	// This member is required.
	AnomalyGroupId *string

	// The ID of the metric.
	TimeSeriesId *string
	// contains filtered or unexported fields
}

An anomalous metric in an anomaly group.

type AnomalyGroupTimeSeriesFeedback 

type AnomalyGroupTimeSeriesFeedback struct {

	// The ID of the anomaly group.
	//
	// This member is required.
	AnomalyGroupId *string

	// Feedback on whether the metric is a legitimate anomaly.
	//
	// This member is required.
	IsAnomaly *bool

	// The ID of the metric.
	//
	// This member is required.
	TimeSeriesId *string
	// contains filtered or unexported fields
}

Feedback for an anomalous metric.

type AppFlowConfig 

type AppFlowConfig struct {

	//  name of the flow.
	FlowName *string

	// An IAM role that gives Amazon Lookout for Metrics permission to access the flow.
	RoleArn *string
	// contains filtered or unexported fields
}

Details about an Amazon AppFlow flow datasource.

type AthenaSourceConfig added in v1.14.0 

type AthenaSourceConfig struct {

	// Settings for backtest mode.
	BackTestConfiguration *BackTestConfiguration

	// The database's data catalog.
	DataCatalog *string

	// The database's name.
	DatabaseName *string

	// An IAM role that gives Amazon Lookout for Metrics permission to access the data.
	RoleArn *string

	// The database's results path.
	S3ResultsPath *string

	// The database's table name.
	TableName *string

	// The database's work group name.
	WorkGroupName *string
	// contains filtered or unexported fields
}

Details about an Amazon Athena datasource.

type AttributeValue added in v1.12.0 

type AttributeValue struct {

	// A binary value.
	B *string

	// A list of binary values.
	BS []string

	// A number.
	N *string

	// A list of numbers.
	NS []string

	// A string.
	S *string

	// A list of strings.
	SS []string
	// contains filtered or unexported fields
}

An attribute value.

type AutoDetectionMetricSource added in v1.12.0 

type AutoDetectionMetricSource struct {

	// The source's source config.
	S3SourceConfig *AutoDetectionS3SourceConfig
	// contains filtered or unexported fields
}

An auto detection metric source.

type AutoDetectionS3SourceConfig added in v1.12.0 

type AutoDetectionS3SourceConfig struct {

	// The config's historical data path list.
	HistoricalDataPathList []string

	// The config's templated path list.
	TemplatedPathList []string
	// contains filtered or unexported fields
}

An auto detection source config.

type BackTestConfiguration added in v1.14.0 

type BackTestConfiguration struct {

	// Run a backtest instead of monitoring new data.
	//
	// This member is required.
	RunBackTestMode *bool
	// contains filtered or unexported fields
}

Settings for backtest mode.

type CSVFileCompression 

type CSVFileCompression string
const (
	CSVFileCompressionNone CSVFileCompression = "NONE"
	CSVFileCompressionGzip CSVFileCompression = "GZIP"
)

Enum values for CSVFileCompression

func (CSVFileCompression) Values 

func (CSVFileCompression) Values() []CSVFileCompression

Values returns all known values for CSVFileCompression. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CloudWatchConfig 

type CloudWatchConfig struct {

	// Settings for backtest mode.
	BackTestConfiguration *BackTestConfiguration

	// An IAM role that gives Amazon Lookout for Metrics permission to access data in
	// Amazon CloudWatch.
	RoleArn *string
	// contains filtered or unexported fields
}

Details about an Amazon CloudWatch datasource.

type Confidence added in v1.12.0 

type Confidence string
const (
	ConfidenceHigh Confidence = "HIGH"
	ConfidenceLow  Confidence = "LOW"
	ConfidenceNone Confidence = "NONE"
)

Enum values for Confidence

func (Confidence) Values added in v1.12.0 

func (Confidence) Values() []Confidence

Values returns all known values for Confidence. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

There was a conflict processing the request. Try your request again.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ContributionMatrix 

type ContributionMatrix struct {

	// A list of contributing dimensions.
	DimensionContributionList []DimensionContribution
	// contains filtered or unexported fields
}

Details about dimensions that contributed to an anomaly.

type CsvFormatDescriptor 

type CsvFormatDescriptor struct {

	// The character set in which the source CSV file is written.
	Charset *string

	// Whether or not the source CSV file contains a header.
	ContainsHeader *bool

	// The character used to delimit the source CSV file.
	Delimiter *string

	// The level of compression of the source CSV file.
	FileCompression CSVFileCompression

	// A list of the source CSV file's headers, if any.
	HeaderList []string

	// The character used as a quote character.
	QuoteSymbol *string
	// contains filtered or unexported fields
}

Contains information about how a source CSV data file should be analyzed.

type DataQualityMetric added in v1.17.0 

type DataQualityMetric struct {

	// A description of the data quality metric.
	MetricDescription *string

	// The name of the data quality metric.
	MetricType DataQualityMetricType

	// The value of the data quality metric.
	MetricValue *float64

	// The column that is being monitored.
	RelatedColumnName *string
	// contains filtered or unexported fields
}

An array that describes a data quality metric. Each DataQualityMetric object contains the data quality metric name, its value, a description of the metric, and the affected column.

type DataQualityMetricType added in v1.17.0 

type DataQualityMetricType string
const (
	DataQualityMetricTypeColumnCompleteness                  DataQualityMetricType = "COLUMN_COMPLETENESS"
	DataQualityMetricTypeDimensionUniqueness                 DataQualityMetricType = "DIMENSION_UNIQUENESS"
	DataQualityMetricTypeTimeSeriesCount                     DataQualityMetricType = "TIME_SERIES_COUNT"
	DataQualityMetricTypeRowsProcessed                       DataQualityMetricType = "ROWS_PROCESSED"
	DataQualityMetricTypeRowsPartialCompliance               DataQualityMetricType = "ROWS_PARTIAL_COMPLIANCE"
	DataQualityMetricTypeInvalidRowsCompliance               DataQualityMetricType = "INVALID_ROWS_COMPLIANCE"
	DataQualityMetricTypeBacktestTrainingDataStartTimeStamp  DataQualityMetricType = "BACKTEST_TRAINING_DATA_START_TIME_STAMP"
	DataQualityMetricTypeBacktestTrainingDataEndTimeStamp    DataQualityMetricType = "BACKTEST_TRAINING_DATA_END_TIME_STAMP"
	DataQualityMetricTypeBacktestInferenceDataStartTimeStamp DataQualityMetricType = "BACKTEST_INFERENCE_DATA_START_TIME_STAMP"
	DataQualityMetricTypeBacktestInferenceDataEndTimeStamp   DataQualityMetricType = "BACKTEST_INFERENCE_DATA_END_TIME_STAMP"
)

Enum values for DataQualityMetricType

func (DataQualityMetricType) Values added in v1.17.0 

func (DataQualityMetricType) Values() []DataQualityMetricType

Values returns all known values for DataQualityMetricType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DetectedCsvFormatDescriptor added in v1.12.0 

type DetectedCsvFormatDescriptor struct {

	// The format's charset.
	Charset *DetectedField

	// Whether the format includes a header.
	ContainsHeader *DetectedField

	// The format's delimiter.
	Delimiter *DetectedField

	// The format's file compression.
	FileCompression *DetectedField

	// The format's header list.
	HeaderList *DetectedField

	// The format's quote symbol.
	QuoteSymbol *DetectedField
	// contains filtered or unexported fields
}

Properties of an inferred CSV format.

type DetectedField added in v1.12.0 

type DetectedField struct {

	// The field's confidence.
	Confidence Confidence

	// The field's message.
	Message *string

	// The field's value.
	Value *AttributeValue
	// contains filtered or unexported fields
}

An inferred field.

type DetectedFileFormatDescriptor added in v1.12.0 

type DetectedFileFormatDescriptor struct {

	// Details about a CSV format.
	CsvFormatDescriptor *DetectedCsvFormatDescriptor

	// Details about a JSON format.
	JsonFormatDescriptor *DetectedJsonFormatDescriptor
	// contains filtered or unexported fields
}

Properties of an inferred data format.

type DetectedJsonFormatDescriptor added in v1.12.0 

type DetectedJsonFormatDescriptor struct {

	// The format's character set.
	Charset *DetectedField

	// The format's file compression.
	FileCompression *DetectedField
	// contains filtered or unexported fields
}

A detected JSON format descriptor.

type DetectedMetricSetConfig added in v1.12.0 

type DetectedMetricSetConfig struct {

	// The dataset's interval.
	MetricSetFrequency *DetectedField

	// The dataset's data source.
	MetricSource *DetectedMetricSource

	// The dataset's offset.
	Offset *DetectedField
	// contains filtered or unexported fields
}

An inferred dataset configuration.

type DetectedMetricSource added in v1.12.0 

type DetectedMetricSource struct {

	// The data source's source configuration.
	S3SourceConfig *DetectedS3SourceConfig
	// contains filtered or unexported fields
}

An inferred data source.

type DetectedS3SourceConfig added in v1.12.0 

type DetectedS3SourceConfig struct {

	// The source's file format descriptor.
	FileFormatDescriptor *DetectedFileFormatDescriptor
	// contains filtered or unexported fields
}

An inferred source configuration.

type DimensionContribution 

type DimensionContribution struct {

	// The name of the dimension.
	DimensionName *string

	// A list of dimension values that contributed to the anomaly.
	DimensionValueContributionList []DimensionValueContribution
	// contains filtered or unexported fields
}

Details about a dimension that contributed to an anomaly.

type DimensionFilter added in v1.16.0 

type DimensionFilter struct {

	// The name of the dimension to filter on.
	DimensionName *string

	// The list of values for the dimension specified in DimensionName that you want
	// to filter on.
	DimensionValueList []string
	// contains filtered or unexported fields
}

The dimension filter, containing DimensionName and DimensionValueList.

type DimensionNameValue 

type DimensionNameValue struct {

	// The name of the dimension.
	//
	// This member is required.
	DimensionName *string

	// The value of the dimension.
	//
	// This member is required.
	DimensionValue *string
	// contains filtered or unexported fields
}

A dimension name and value.

type DimensionValueContribution 

type DimensionValueContribution struct {

	// The severity score of the value.
	ContributionScore *float64

	// The value of the dimension.
	DimensionValue *string
	// contains filtered or unexported fields
}

The severity of a value of a dimension that contributed to an anomaly.

type ExecutionStatus 

type ExecutionStatus struct {

	// The reason that the run failed, if applicable.
	FailureReason *string

	// The run's status.
	Status AnomalyDetectionTaskStatus

	// The run's timestamp.
	Timestamp *string
	// contains filtered or unexported fields
}

The status of an anomaly detector run.

type FileFormatDescriptor 

type FileFormatDescriptor struct {

	// Contains information about how a source CSV data file should be analyzed.
	CsvFormatDescriptor *CsvFormatDescriptor

	// Contains information about how a source JSON data file should be analyzed.
	JsonFormatDescriptor *JsonFormatDescriptor
	// contains filtered or unexported fields
}

Contains information about a source file's formatting.

type Filter added in v1.18.0 

type Filter struct {

	// The value that you want to include in the filter.
	DimensionValue *string

	// The condition to apply.
	FilterOperation FilterOperation
	// contains filtered or unexported fields
}

Describes a filter for choosing a subset of dimension values. Each filter consists of the dimension that you want to include and the condition statement. The condition statement is specified in the FilterOperation object.

type FilterOperation added in v1.18.0 

type FilterOperation string
const (
	FilterOperationEquals FilterOperation = "EQUALS"
)

Enum values for FilterOperation

func (FilterOperation) Values added in v1.18.0 

func (FilterOperation) Values() []FilterOperation

Values returns all known values for FilterOperation. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Frequency 

type Frequency string
const (
	FrequencyP1d   Frequency = "P1D"
	FrequencyPt1h  Frequency = "PT1H"
	FrequencyPt10m Frequency = "PT10M"
	FrequencyPt5m  Frequency = "PT5M"
)

Enum values for Frequency

func (Frequency) Values 

func (Frequency) Values() []Frequency

Values returns all known values for Frequency. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InterMetricImpactDetails added in v1.6.0 

type InterMetricImpactDetails struct {

	// The ID of the anomaly group.
	AnomalyGroupId *string

	// For potential causes ( CAUSE_OF_INPUT_ANOMALY_GROUP ), the percentage
	// contribution the measure has in causing the anomalies.
	ContributionPercentage *float64

	// The name of the measure.
	MetricName *string

	// Whether a measure is a potential cause of the anomaly group (
	// CAUSE_OF_INPUT_ANOMALY_GROUP ), or whether the measure is impacted by the
	// anomaly group ( EFFECT_OF_INPUT_ANOMALY_GROUP ).
	RelationshipType RelationshipType
	// contains filtered or unexported fields
}

Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request processing has failed because of an unknown error, exception, or failure.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type ItemizedMetricStats 

type ItemizedMetricStats struct {

	// The name of the measure.
	MetricName *string

	// The number of times that the measure appears.
	OccurrenceCount int32
	// contains filtered or unexported fields
}

Aggregated statistics about a measure affected by an anomaly.

type JsonFileCompression 

type JsonFileCompression string
const (
	JsonFileCompressionNone JsonFileCompression = "NONE"
	JsonFileCompressionGzip JsonFileCompression = "GZIP"
)

Enum values for JsonFileCompression

func (JsonFileCompression) Values 

func (JsonFileCompression) Values() []JsonFileCompression

Values returns all known values for JsonFileCompression. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JsonFormatDescriptor 

type JsonFormatDescriptor struct {

	// The character set in which the source JSON file is written.
	Charset *string

	// The level of compression of the source CSV file.
	FileCompression JsonFileCompression
	// contains filtered or unexported fields
}

Contains information about how a source JSON data file should be analyzed.

type LambdaConfiguration 

type LambdaConfiguration struct {

	// The ARN of the Lambda function.
	//
	// This member is required.
	LambdaArn *string

	// The ARN of an IAM role that has permission to invoke the Lambda function.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

Contains information about a Lambda configuration.

type Metric 

type Metric struct {

	// The function with which the metric is calculated.
	//
	// This member is required.
	AggregationFunction AggregationFunction

	// The name of the metric.
	//
	// This member is required.
	MetricName *string

	// The namespace for the metric.
	Namespace *string
	// contains filtered or unexported fields
}

A calculation made by contrasting a measure and a dimension from your source data.

type MetricLevelImpact 

type MetricLevelImpact struct {

	// Details about the dimensions that contributed to the anomaly.
	ContributionMatrix *ContributionMatrix

	// The name of the measure.
	MetricName *string

	// The number of anomalous metrics for the measure.
	NumTimeSeries int32
	// contains filtered or unexported fields
}

Details about a measure affected by an anomaly.

type MetricSetDataQualityMetric added in v1.17.0 

type MetricSetDataQualityMetric struct {

	// The array of data quality metrics contained in the data quality metric set.
	DataQualityMetricList []DataQualityMetric

	// The Amazon Resource Name (ARN) of the data quality metric array.
	MetricSetArn *string
	// contains filtered or unexported fields
}

An array of DataQualityMetric objects that describes one or more data quality metrics.

type MetricSetDimensionFilter added in v1.18.0 

type MetricSetDimensionFilter struct {

	// The list of filters that you are applying.
	FilterList []Filter

	// The dimension that you want to filter on.
	Name *string
	// contains filtered or unexported fields
}

Describes a list of filters for choosing a subset of dimension values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

type MetricSetSummary 

type MetricSetSummary struct {

	// The ARN of the detector to which the dataset belongs.
	AnomalyDetectorArn *string

	// The time at which the dataset was created.
	CreationTime *time.Time

	// The time at which the dataset was last modified.
	LastModificationTime *time.Time

	// The ARN of the dataset.
	MetricSetArn *string

	// The description of the dataset.
	MetricSetDescription *string

	// The name of the dataset.
	MetricSetName *string

	// The dataset's [tags].
	//
	// [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
	Tags map[string]string
	// contains filtered or unexported fields
}

Contains information about a dataset.

type MetricSource 

type MetricSource struct {

	// Details about an AppFlow datasource.
	AppFlowConfig *AppFlowConfig

	// Details about an Amazon Athena datasource.
	AthenaSourceConfig *AthenaSourceConfig

	// Details about an Amazon CloudWatch monitoring datasource.
	CloudWatchConfig *CloudWatchConfig

	// Details about an Amazon Relational Database Service (RDS) datasource.
	RDSSourceConfig *RDSSourceConfig

	// Details about an Amazon Redshift database datasource.
	RedshiftSourceConfig *RedshiftSourceConfig

	// Contains information about the configuration of the S3 bucket that contains
	// source files.
	S3SourceConfig *S3SourceConfig
	// contains filtered or unexported fields
}

Contains information about source data used to generate metrics.

type RDSSourceConfig 

type RDSSourceConfig struct {

	// A string identifying the database instance.
	DBInstanceIdentifier *string

	// The host name of the database.
	DatabaseHost *string

	// The name of the RDS database.
	DatabaseName *string

	// The port number where the database can be accessed.
	DatabasePort *int32

	// The Amazon Resource Name (ARN) of the role.
	RoleArn *string

	// The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
	SecretManagerArn *string

	// The name of the table in the database.
	TableName *string

	// An object containing information about the Amazon Virtual Private Cloud (VPC)
	// configuration.
	VpcConfiguration *VpcConfiguration
	// contains filtered or unexported fields
}

Contains information about the Amazon Relational Database Service (RDS) configuration.

type RedshiftSourceConfig 

type RedshiftSourceConfig struct {

	// A string identifying the Redshift cluster.
	ClusterIdentifier *string

	// The name of the database host.
	DatabaseHost *string

	// The Redshift database name.
	DatabaseName *string

	// The port number where the database can be accessed.
	DatabasePort *int32

	// The Amazon Resource Name (ARN) of the role providing access to the database.
	RoleArn *string

	// The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
	SecretManagerArn *string

	// The table name of the Redshift database.
	TableName *string

	// Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
	VpcConfiguration *VpcConfiguration
	// contains filtered or unexported fields
}

Provides information about the Amazon Redshift database configuration.

type RelationshipType added in v1.6.0 

type RelationshipType string
const (
	RelationshipTypeCauseOfInputAnomalyGroup  RelationshipType = "CAUSE_OF_INPUT_ANOMALY_GROUP"
	RelationshipTypeEffectOfInputAnomalyGroup RelationshipType = "EFFECT_OF_INPUT_ANOMALY_GROUP"
)

Enum values for RelationshipType

func (RelationshipType) Values added in v1.6.0 

func (RelationshipType) Values() []RelationshipType

Values returns all known values for RelationshipType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The specified resource cannot be found. Check the ARN of the resource and try again.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type S3SourceConfig 

type S3SourceConfig struct {

	// Contains information about a source file's formatting.
	FileFormatDescriptor *FileFormatDescriptor

	// A list of paths to the historical data files.
	HistoricalDataPathList []string

	// The ARN of an IAM role that has read and write access permissions to the source
	// S3 bucket.
	RoleArn *string

	// A list of templated paths to the source files.
	TemplatedPathList []string
	// contains filtered or unexported fields
}

Contains information about the configuration of the S3 bucket that contains source files.

type SNSConfiguration 

type SNSConfiguration struct {

	// The ARN of the IAM role that has access to the target SNS topic.
	//
	// This member is required.
	RoleArn *string

	// The ARN of the target SNS topic.
	//
	// This member is required.
	SnsTopicArn *string

	// The format of the SNS topic.
	//
	//   - JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail
	//   page. This is the default.
	//
	//   - LONG_TEXT – Send human-readable alerts with information about the impacted
	//   timeseries and a link to the anomaly detail page. We recommend this for email.
	//
	//   - SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail
	//   page. We recommend this for SMS.
	SnsFormat SnsFormat
	// contains filtered or unexported fields
}

Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic.

type SampleDataS3SourceConfig 

type SampleDataS3SourceConfig struct {

	// Contains information about a source file's formatting.
	//
	// This member is required.
	FileFormatDescriptor *FileFormatDescriptor

	// The Amazon Resource Name (ARN) of the role.
	//
	// This member is required.
	RoleArn *string

	// An array of strings containing the historical set of data paths.
	HistoricalDataPathList []string

	// An array of strings containing the list of templated paths.
	TemplatedPathList []string
	// contains filtered or unexported fields
}

Contains information about the source configuration in Amazon S3.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	QuotaCode    *string
	ServiceCode  *string
	// contains filtered or unexported fields
}

The request exceeded the service's quotas. Check the service quotas and try again.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SnsFormat added in v1.13.0 

type SnsFormat string
const (
	SnsFormatLongText  SnsFormat = "LONG_TEXT"
	SnsFormatShortText SnsFormat = "SHORT_TEXT"
	SnsFormatJson      SnsFormat = "JSON"
)

Enum values for SnsFormat

func (SnsFormat) Values added in v1.13.0 

func (SnsFormat) Values() []SnsFormat

Values returns all known values for SnsFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TimeSeries 

type TimeSeries struct {

	// The dimensions of the metric.
	//
	// This member is required.
	DimensionList []DimensionNameValue

	// The values for the metric.
	//
	// This member is required.
	MetricValueList []float64

	// The ID of the metric.
	//
	// This member is required.
	TimeSeriesId *string
	// contains filtered or unexported fields
}

Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as availability in the us-east-1 Region.

type TimeSeriesFeedback 

type TimeSeriesFeedback struct {

	// Feedback on whether the metric is a legitimate anomaly.
	IsAnomaly *bool

	// The ID of the metric.
	TimeSeriesId *string
	// contains filtered or unexported fields
}

Details about feedback submitted for an anomalous metric.

type TimestampColumn 

type TimestampColumn struct {

	// The format of the timestamp column.
	ColumnFormat *string

	// The name of the timestamp column.
	ColumnName *string
	// contains filtered or unexported fields
}

Contains information about the column used to track time in a source data file.

type TooManyRequestsException 

type TooManyRequestsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was denied due to too many requests being submitted at the same time.

func (*TooManyRequestsException) Error 

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode 

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault 

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage 

func (e *TooManyRequestsException) ErrorMessage() string

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason ValidationExceptionReason
	Fields []ValidationExceptionField
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by the AWS service. Check your input values and try again.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// The message with more information about the validation exception.
	//
	// This member is required.
	Message *string

	// The name of the field.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Contains information about a a field in a validation exception.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "CANNOT_PARSE"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VpcConfiguration 

type VpcConfiguration struct {

	// An array of strings containing the list of security groups.
	//
	// This member is required.
	SecurityGroupIdList []string

	// An array of strings containing the Amazon VPC subnet IDs (e.g.,
	// subnet-0bb1c79de3EXAMPLE .
	//
	// This member is required.
	SubnetIdList []string
	// contains filtered or unexported fields
}

Contains configuration information about the Amazon Virtual Private Cloud (VPC).

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.