types

package
v0.0.0-...-68f2935 Latest Latest
Warning

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

 Go to latest Published: May 24, 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
}

The request could not be completed because you do not have access to the resource.

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 AutoPromotionResult 

type AutoPromotionResult string
const (
	AutoPromotionResultModelPromoted           AutoPromotionResult = "MODEL_PROMOTED"
	AutoPromotionResultModelNotPromoted        AutoPromotionResult = "MODEL_NOT_PROMOTED"
	AutoPromotionResultRetrainingInternalError AutoPromotionResult = "RETRAINING_INTERNAL_ERROR"
	AutoPromotionResultRetrainingCustomerError AutoPromotionResult = "RETRAINING_CUSTOMER_ERROR"
	AutoPromotionResultRetrainingCancelled     AutoPromotionResult = "RETRAINING_CANCELLED"
)

Enum values for AutoPromotionResult

func (AutoPromotionResult) Values 

func (AutoPromotionResult) Values() []AutoPromotionResult

Values returns all known values for AutoPromotionResult. 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 CategoricalValues 

type CategoricalValues struct {

	//  Indicates whether there is a potential data issue related to categorical
	// values.
	//
	// This member is required.
	Status StatisticalIssueStatus

	//  Indicates the number of categories in the data.
	NumberOfCategory *int32
	// contains filtered or unexported fields
}

Entity that comprises information on categorical values in data.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}
The request could not be completed due to a conflict with the current state of

the target resource.

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 CountPercent 

type CountPercent struct {

	//  Indicates the count of occurences of the given statistic.
	//
	// This member is required.
	Count *int32

	//  Indicates the percentage of occurances of the given statistic.
	//
	// This member is required.
	Percentage float32
	// contains filtered or unexported fields
}

Entity that comprises information of count and percentage.

type DataIngestionJobSummary 

type DataIngestionJobSummary struct {

	// The Amazon Resource Name (ARN) of the dataset used in the data ingestion job.
	DatasetArn *string

	// The name of the dataset used for the data ingestion job.
	DatasetName *string

	//  Specifies information for the input data for the data inference job, including
	// data Amazon S3 location parameters.
	IngestionInputConfiguration *IngestionInputConfiguration

	// Indicates the job ID of the data ingestion job.
	JobId *string

	// Indicates the status of the data ingestion job.
	Status IngestionJobStatus
	// contains filtered or unexported fields
}

Provides information about a specified data ingestion job, including dataset information, data ingestion configuration, and status.

type DataPreProcessingConfiguration 

type DataPreProcessingConfiguration struct {

	// The sampling rate of the data after post processing by Amazon Lookout for
	// Equipment. For example, if you provide data that has been collected at a 1
	// second level and you want the system to resample the data at a 1 minute rate
	// before training, the TargetSamplingRate is 1 minute.
	//
	// When providing a value for the TargetSamplingRate , you must attach the prefix
	// "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the
	// value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H
	TargetSamplingRate TargetSamplingRate
	// contains filtered or unexported fields
}

The configuration is the TargetSamplingRate , which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

When providing a value for the TargetSamplingRate , you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

type DataQualitySummary 

type DataQualitySummary struct {

	//  Parameter that gives information about duplicate timestamps in the input data.
	//
	// This member is required.
	DuplicateTimestamps *DuplicateTimestamps

	//  Parameter that gives information about insufficient data for sensors in the
	// dataset. This includes information about those sensors that have complete data
	// missing and those with a short date range.
	//
	// This member is required.
	InsufficientSensorData *InsufficientSensorData

	//  Parameter that gives information about data that is invalid over all the
	// sensors in the input data.
	//
	// This member is required.
	InvalidSensorData *InvalidSensorData

	//  Parameter that gives information about data that is missing over all the
	// sensors in the input data.
	//
	// This member is required.
	MissingSensorData *MissingSensorData

	//  Parameter that gives information about unsupported timestamps in the input
	// data.
	//
	// This member is required.
	UnsupportedTimestamps *UnsupportedTimestamps
	// contains filtered or unexported fields
}
DataQualitySummary gives aggregated statistics over all the sensors about a

completed ingestion job. It primarily gives more information about statistics over different incorrect data like MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, DuplicateTimeStamps.

type DataUploadFrequency 

type DataUploadFrequency string
const (
	DataUploadFrequencyPt5m  DataUploadFrequency = "PT5M"
	DataUploadFrequencyPt10m DataUploadFrequency = "PT10M"
	DataUploadFrequencyPt15m DataUploadFrequency = "PT15M"
	DataUploadFrequencyPt30m DataUploadFrequency = "PT30M"
	DataUploadFrequencyPt1h  DataUploadFrequency = "PT1H"
)

Enum values for DataUploadFrequency

func (DataUploadFrequency) Values 

func (DataUploadFrequency) Values() []DataUploadFrequency

Values returns all known values for DataUploadFrequency. 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 DatasetSchema 

type DatasetSchema struct {

	// The data schema used within the given dataset.
	//
	// This value conforms to the media type: application/json
	InlineDataSchema *string
	// contains filtered or unexported fields
}

Provides information about the data schema used with the given dataset.

type DatasetStatus 

type DatasetStatus string
const (
	DatasetStatusCreated             DatasetStatus = "CREATED"
	DatasetStatusIngestionInProgress DatasetStatus = "INGESTION_IN_PROGRESS"
	DatasetStatusActive              DatasetStatus = "ACTIVE"
	DatasetStatusImportInProgress    DatasetStatus = "IMPORT_IN_PROGRESS"
)

Enum values for DatasetStatus

func (DatasetStatus) Values 

func (DatasetStatus) Values() []DatasetStatus

Values returns all known values for DatasetStatus. 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 DatasetSummary 

type DatasetSummary struct {

	// The time at which the dataset was created in Amazon Lookout for Equipment.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the specified dataset.
	DatasetArn *string

	// The name of the dataset.
	DatasetName *string

	// Indicates the status of the dataset.
	Status DatasetStatus
	// contains filtered or unexported fields
}

Contains information about the specific data set, including name, ARN, and status.

type DuplicateTimestamps 

type DuplicateTimestamps struct {

	//  Indicates the total number of duplicate timestamps.
	//
	// This member is required.
	TotalNumberOfDuplicateTimestamps *int32
	// contains filtered or unexported fields
}

Entity that comprises information abount duplicate timestamps in the dataset.

type InferenceDataImportStrategy 

type InferenceDataImportStrategy string
const (
	InferenceDataImportStrategyNoImport     InferenceDataImportStrategy = "NO_IMPORT"
	InferenceDataImportStrategyAddWhenEmpty InferenceDataImportStrategy = "ADD_WHEN_EMPTY"
	InferenceDataImportStrategyOverwrite    InferenceDataImportStrategy = "OVERWRITE"
)

Enum values for InferenceDataImportStrategy

func (InferenceDataImportStrategy) Values 

func (InferenceDataImportStrategy) Values() []InferenceDataImportStrategy

Values returns all known values for InferenceDataImportStrategy. 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 InferenceEventSummary 

type InferenceEventSummary struct {

	//  An array which specifies the names and values of all sensors contributing to
	// an inference event.
	Diagnostics *string

	//  Indicates the size of an inference event in seconds.
	EventDurationInSeconds *int64

	// Indicates the ending time of an inference event.
	EventEndTime *time.Time

	// Indicates the starting time of an inference event.
	EventStartTime *time.Time

	//  The Amazon Resource Name (ARN) of the inference scheduler being used for the
	// inference event.
	InferenceSchedulerArn *string

	// The name of the inference scheduler being used for the inference events.
	InferenceSchedulerName *string
	// contains filtered or unexported fields
}

Contains information about the specific inference event, including start and end time, diagnostics information, event duration and so on.

type InferenceExecutionStatus 

type InferenceExecutionStatus string
const (
	InferenceExecutionStatusInProgress InferenceExecutionStatus = "IN_PROGRESS"
	InferenceExecutionStatusSuccess    InferenceExecutionStatus = "SUCCESS"
	InferenceExecutionStatusFailed     InferenceExecutionStatus = "FAILED"
)

Enum values for InferenceExecutionStatus

func (InferenceExecutionStatus) Values 

func (InferenceExecutionStatus) Values() []InferenceExecutionStatus

Values returns all known values for InferenceExecutionStatus. 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 InferenceExecutionSummary 

type InferenceExecutionSummary struct {

	// The S3 object that the inference execution results were uploaded to.
	CustomerResultObject *S3Object

	// Indicates the time reference in the dataset at which the inference execution
	// stopped.
	DataEndTime *time.Time

	//  Specifies configuration information for the input data for the inference
	// scheduler, including delimiter, format, and dataset location.
	DataInputConfiguration *InferenceInputConfiguration

	//  Specifies configuration information for the output results from for the
	// inference execution, including the output Amazon S3 location.
	DataOutputConfiguration *InferenceOutputConfiguration

	// Indicates the time reference in the dataset at which the inference execution
	// began.
	DataStartTime *time.Time

	//  Specifies the reason for failure when an inference execution has failed.
	FailedReason *string

	//  The Amazon Resource Name (ARN) of the inference scheduler being used for the
	// inference execution.
	InferenceSchedulerArn *string

	// The name of the inference scheduler being used for the inference execution.
	InferenceSchedulerName *string

	// The Amazon Resource Name (ARN) of the machine learning model used for the
	// inference execution.
	ModelArn *string

	// The name of the machine learning model being used for the inference execution.
	ModelName *string

	// The model version used for the inference execution.
	ModelVersion *int64

	// The Amazon Resource Number (ARN) of the model version used for the inference
	// execution.
	ModelVersionArn *string

	// Indicates the start time at which the inference scheduler began the specific
	// inference execution.
	ScheduledStartTime *time.Time

	// Indicates the status of the inference execution.
	Status InferenceExecutionStatus
	// contains filtered or unexported fields
}

Contains information about the specific inference execution, including input and output data configuration, inference scheduling information, status, and so on.

type InferenceInputConfiguration 

type InferenceInputConfiguration struct {

	// Specifies configuration information for the input data for the inference,
	// including timestamp format and delimiter.
	InferenceInputNameConfiguration *InferenceInputNameConfiguration

	// Indicates the difference between your time zone and Coordinated Universal Time
	// (UTC).
	InputTimeZoneOffset *string

	//  Specifies configuration information for the input data for the inference,
	// including Amazon S3 location of input data.
	S3InputConfiguration *InferenceS3InputConfiguration
	// contains filtered or unexported fields
}

Specifies configuration information for the input data for the inference, including Amazon S3 location of input data..

type InferenceInputNameConfiguration 

type InferenceInputNameConfiguration struct {

	// Indicates the delimiter character used between items in the data.
	ComponentTimestampDelimiter *string

	// The format of the timestamp, whether Epoch time, or standard, with or without
	// hyphens (-).
	TimestampFormat *string
	// contains filtered or unexported fields
}

Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

type InferenceOutputConfiguration 

type InferenceOutputConfiguration struct {

	//  Specifies configuration information for the output results from for the
	// inference, output S3 location.
	//
	// This member is required.
	S3OutputConfiguration *InferenceS3OutputConfiguration

	// The ID number for the KMS key key used to encrypt the inference output.
	KmsKeyId *string
	// contains filtered or unexported fields
}
Specifies configuration information for the output results from for the

inference, including KMS key ID and output S3 location.

type InferenceS3InputConfiguration 

type InferenceS3InputConfiguration struct {

	// The bucket containing the input dataset for the inference.
	//
	// This member is required.
	Bucket *string

	// The prefix for the S3 bucket used for the input data for the inference.
	Prefix *string
	// contains filtered or unexported fields
}
Specifies configuration information for the input data for the inference,

including input data S3 location.

type InferenceS3OutputConfiguration 

type InferenceS3OutputConfiguration struct {

	//  The bucket containing the output results from the inference
	//
	// This member is required.
	Bucket *string

	//  The prefix for the S3 bucket used for the output results from the inference.
	Prefix *string
	// contains filtered or unexported fields
}
Specifies configuration information for the output results from the inference,

including output S3 location.

type InferenceSchedulerStatus 

type InferenceSchedulerStatus string
const (
	InferenceSchedulerStatusPending  InferenceSchedulerStatus = "PENDING"
	InferenceSchedulerStatusRunning  InferenceSchedulerStatus = "RUNNING"
	InferenceSchedulerStatusStopping InferenceSchedulerStatus = "STOPPING"
	InferenceSchedulerStatusStopped  InferenceSchedulerStatus = "STOPPED"
)

Enum values for InferenceSchedulerStatus

func (InferenceSchedulerStatus) Values 

func (InferenceSchedulerStatus) Values() []InferenceSchedulerStatus

Values returns all known values for InferenceSchedulerStatus. 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 InferenceSchedulerSummary 

type InferenceSchedulerSummary struct {

	// A period of time (in minutes) by which inference on the data is delayed after
	// the data starts. For instance, if an offset delay time of five minutes was
	// selected, inference will not begin on the data until the first data measurement
	// after the five minute mark. For example, if five minutes is selected, the
	// inference scheduler will wake up at the configured frequency with the additional
	// five minute delay time to check the customer S3 bucket. The customer can upload
	// data at the same frequency and they don't need to stop and restart the scheduler
	// when uploading new data.
	DataDelayOffsetInMinutes *int64

	// How often data is uploaded to the source S3 bucket for the input data. This
	// value is the length of time between data uploads. For instance, if you select 5
	// minutes, Amazon Lookout for Equipment will upload the real-time data to the
	// source bucket once every 5 minutes. This frequency also determines how often
	// Amazon Lookout for Equipment starts a scheduled inference on your data. In this
	// example, it starts once every 5 minutes.
	DataUploadFrequency DataUploadFrequency

	//  The Amazon Resource Name (ARN) of the inference scheduler.
	InferenceSchedulerArn *string

	// The name of the inference scheduler.
	InferenceSchedulerName *string

	// Indicates whether the latest execution for the inference scheduler was
	// Anomalous (anomalous events found) or Normal (no anomalous events found).
	LatestInferenceResult LatestInferenceResult

	//  The Amazon Resource Name (ARN) of the machine learning model used by the
	// inference scheduler.
	ModelArn *string

	// The name of the machine learning model used for the inference scheduler.
	ModelName *string

	// Indicates the status of the inference scheduler.
	Status InferenceSchedulerStatus
	// contains filtered or unexported fields
}

Contains information about the specific inference scheduler, including data delay offset, model name and ARN, status, and so on.

type IngestedFilesSummary 

type IngestedFilesSummary struct {

	// Indicates the number of files that were successfully ingested.
	//
	// This member is required.
	IngestedNumberOfFiles *int32

	// Indicates the total number of files that were submitted for ingestion.
	//
	// This member is required.
	TotalNumberOfFiles *int32

	// Indicates the number of files that were discarded. A file could be discarded
	// because its format is invalid (for example, a jpg or pdf) or not readable.
	DiscardedFiles []S3Object
	// contains filtered or unexported fields
}

Gives statistics about how many files have been ingested, and which files have not been ingested, for a particular ingestion job.

type IngestionInputConfiguration 

type IngestionInputConfiguration struct {

	// The location information for the S3 bucket used for input data for the data
	// ingestion.
	//
	// This member is required.
	S3InputConfiguration *IngestionS3InputConfiguration
	// contains filtered or unexported fields
}
Specifies configuration information for the input data for the data ingestion

job, including input data S3 location.

type IngestionJobStatus 

type IngestionJobStatus string
const (
	IngestionJobStatusInProgress       IngestionJobStatus = "IN_PROGRESS"
	IngestionJobStatusSuccess          IngestionJobStatus = "SUCCESS"
	IngestionJobStatusFailed           IngestionJobStatus = "FAILED"
	IngestionJobStatusImportInProgress IngestionJobStatus = "IMPORT_IN_PROGRESS"
)

Enum values for IngestionJobStatus

func (IngestionJobStatus) Values 

func (IngestionJobStatus) Values() []IngestionJobStatus

Values returns all known values for IngestionJobStatus. 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 IngestionS3InputConfiguration 

type IngestionS3InputConfiguration struct {

	// The name of the S3 bucket used for the input data for the data ingestion.
	//
	// This member is required.
	Bucket *string

	//  The pattern for matching the Amazon S3 files that will be used for ingestion.
	// If the schema was created previously without any KeyPattern, then the default
	// KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3
	// according to the schema. This field is required when ingestion is being done for
	// the first time.
	//
	// Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* |
	// {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot,
	// underscore, hyphen)
	KeyPattern *string

	// The prefix for the S3 location being used for the input data for the data
	// ingestion.
	Prefix *string
	// contains filtered or unexported fields
}
Specifies S3 configuration information for the input data for the data

ingestion job.

type InsufficientSensorData 

type InsufficientSensorData struct {

	//  Parameter that describes the total number of sensors that have data completely
	// missing for it.
	//
	// This member is required.
	MissingCompleteSensorData *MissingCompleteSensorData

	//  Parameter that describes the total number of sensors that have a short date
	// range of less than 14 days of data overall.
	//
	// This member is required.
	SensorsWithShortDateRange *SensorsWithShortDateRange
	// contains filtered or unexported fields
}
Entity that comprises aggregated information on sensors having insufficient

data.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}
Processing of the request 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 InvalidSensorData 

type InvalidSensorData struct {

	//  Indicates the number of sensors that have at least some invalid values.
	//
	// This member is required.
	AffectedSensorCount *int32

	//  Indicates the total number of invalid values across all the sensors.
	//
	// This member is required.
	TotalNumberOfInvalidValues *int32
	// contains filtered or unexported fields
}
Entity that comprises aggregated information on sensors having insufficient

data.

type LabelGroupSummary 

type LabelGroupSummary struct {

	//  The time at which the label group was created.
	CreatedAt *time.Time

	//  The Amazon Resource Name (ARN) of the label group.
	LabelGroupArn *string

	//  The name of the label group.
	LabelGroupName *string

	//  The time at which the label group was updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Contains information about the label group.

type LabelRating 

type LabelRating string
const (
	LabelRatingAnomaly   LabelRating = "ANOMALY"
	LabelRatingNoAnomaly LabelRating = "NO_ANOMALY"
	LabelRatingNeutral   LabelRating = "NEUTRAL"
)

Enum values for LabelRating

func (LabelRating) Values 

func (LabelRating) Values() []LabelRating

Values returns all known values for LabelRating. 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 LabelSummary 

type LabelSummary struct {

	//  The time at which the label was created.
	CreatedAt *time.Time

	//  The timestamp indicating the end of the label.
	EndTime *time.Time

	//  Indicates that a label pertains to a particular piece of equipment.
	Equipment *string

	//  Indicates the type of anomaly associated with the label.
	//
	// Data in this field will be retained for service usage. Follow best practices
	// for the security of your data.
	FaultCode *string

	//  The Amazon Resource Name (ARN) of the label group.
	LabelGroupArn *string

	//  The name of the label group.
	LabelGroupName *string

	//  The ID of the label.
	LabelId *string

	//  Indicates whether a labeled event represents an anomaly.
	Rating LabelRating

	//  The timestamp indicating the start of the label.
	StartTime *time.Time
	// contains filtered or unexported fields
}

Information about the label.

type LabelsInputConfiguration 

type LabelsInputConfiguration struct {

	//  The name of the label group to be used for label data.
	LabelGroupName *string

	// Contains location information for the S3 location being used for label data.
	S3InputConfiguration *LabelsS3InputConfiguration
	// contains filtered or unexported fields
}

Contains the configuration information for the S3 location being used to hold label data.

type LabelsS3InputConfiguration 

type LabelsS3InputConfiguration struct {

	// The name of the S3 bucket holding the label data.
	//
	// This member is required.
	Bucket *string

	//  The prefix for the S3 bucket used for the label data.
	Prefix *string
	// contains filtered or unexported fields
}

The location information (prefix and bucket name) for the s3 location being used for label data.

type LargeTimestampGaps 

type LargeTimestampGaps struct {

	//  Indicates whether there is a potential data issue related to large gaps in
	// timestamps.
	//
	// This member is required.
	Status StatisticalIssueStatus

	//  Indicates the size of the largest timestamp gap, in days.
	MaxTimestampGapInDays *int32

	//  Indicates the number of large timestamp gaps, if there are any.
	NumberOfLargeTimestampGaps *int32
	// contains filtered or unexported fields
}
Entity that comprises information on large gaps between consecutive timestamps

in data.

type LatestInferenceResult 

type LatestInferenceResult string
const (
	LatestInferenceResultAnomalous LatestInferenceResult = "ANOMALOUS"
	LatestInferenceResultNormal    LatestInferenceResult = "NORMAL"
)

Enum values for LatestInferenceResult

func (LatestInferenceResult) Values 

func (LatestInferenceResult) Values() []LatestInferenceResult

Values returns all known values for LatestInferenceResult. 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 MissingCompleteSensorData 

type MissingCompleteSensorData struct {

	//  Indicates the number of sensors that have data missing completely.
	//
	// This member is required.
	AffectedSensorCount *int32
	// contains filtered or unexported fields
}
Entity that comprises information on sensors that have sensor data completely

missing.

type MissingSensorData 

type MissingSensorData struct {

	//  Indicates the number of sensors that have atleast some data missing.
	//
	// This member is required.
	AffectedSensorCount *int32

	//  Indicates the total number of missing values across all the sensors.
	//
	// This member is required.
	TotalNumberOfMissingValues *int32
	// contains filtered or unexported fields
}

Entity that comprises aggregated information on sensors having missing data.

type ModelDiagnosticsOutputConfiguration 

type ModelDiagnosticsOutputConfiguration struct {

	// The Amazon S3 location for the pointwise model diagnostics.
	//
	// This member is required.
	S3OutputConfiguration *ModelDiagnosticsS3OutputConfiguration

	// The Amazon Web Services Key Management Service (KMS) key identifier to encrypt
	// the pointwise model diagnostics files.
	KmsKeyId *string
	// contains filtered or unexported fields
}

Output configuration information for the pointwise model diagnostics for an Amazon Lookout for Equipment model.

type ModelDiagnosticsS3OutputConfiguration 

type ModelDiagnosticsS3OutputConfiguration struct {

	// The name of the Amazon S3 bucket where the pointwise model diagnostics are
	// located. You must be the owner of the Amazon S3 bucket.
	//
	// This member is required.
	Bucket *string

	// The Amazon S3 prefix for the location of the pointwise model diagnostics. The
	// prefix specifies the folder and evaluation result file name. ( bucket ).
	//
	// When you call CreateModel or UpdateModel , specify the path within the bucket
	// that you want Lookout for Equipment to save the model to. During training,
	// Lookout for Equipment creates the model evaluation model as a compressed JSON
	// file with the name model_diagnostics_results.json.gz .
	//
	// When you call DescribeModel or DescribeModelVersion , prefix contains the file
	// path and filename of the model evaluation file.
	Prefix *string
	// contains filtered or unexported fields
}

The Amazon S3 location for the pointwise model diagnostics for an Amazon Lookout for Equipment model.

type ModelPromoteMode 

type ModelPromoteMode string
const (
	ModelPromoteModeManaged ModelPromoteMode = "MANAGED"
	ModelPromoteModeManual  ModelPromoteMode = "MANUAL"
)

Enum values for ModelPromoteMode

func (ModelPromoteMode) Values 

func (ModelPromoteMode) Values() []ModelPromoteMode

Values returns all known values for ModelPromoteMode. 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 ModelQuality 

type ModelQuality string
const (
	ModelQualityQualityThresholdMet    ModelQuality = "QUALITY_THRESHOLD_MET"
	ModelQualityCannotDetermineQuality ModelQuality = "CANNOT_DETERMINE_QUALITY"
	ModelQualityPoorQualityDetected    ModelQuality = "POOR_QUALITY_DETECTED"
)

Enum values for ModelQuality

func (ModelQuality) Values 

func (ModelQuality) Values() []ModelQuality

Values returns all known values for ModelQuality. 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 ModelStatus 

type ModelStatus string
const (
	ModelStatusInProgress       ModelStatus = "IN_PROGRESS"
	ModelStatusSuccess          ModelStatus = "SUCCESS"
	ModelStatusFailed           ModelStatus = "FAILED"
	ModelStatusImportInProgress ModelStatus = "IMPORT_IN_PROGRESS"
)

Enum values for ModelStatus

func (ModelStatus) Values 

func (ModelStatus) Values() []ModelStatus

Values returns all known values for ModelStatus. 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 ModelSummary 

type ModelSummary struct {

	// The model version that the inference scheduler uses to run an inference
	// execution.
	ActiveModelVersion *int64

	// The Amazon Resource Name (ARN) of the model version that is set as active. The
	// active model version is the model version that the inference scheduler uses to
	// run an inference execution.
	ActiveModelVersionArn *string

	// The time at which the specific model was created.
	CreatedAt *time.Time

	//  The Amazon Resource Name (ARN) of the dataset used to create the model.
	DatasetArn *string

	// The name of the dataset being used for the machine learning model.
	DatasetName *string

	// Indicates the most recent model version that was generated by retraining.
	LatestScheduledRetrainingModelVersion *int64

	// Indicates the start time of the most recent scheduled retraining run.
	LatestScheduledRetrainingStartTime *time.Time

	// Indicates the status of the most recent scheduled retraining run.
	LatestScheduledRetrainingStatus ModelVersionStatus

	//  The Amazon Resource Name (ARN) of the machine learning model.
	ModelArn *string

	// Output configuration information for the pointwise model diagnostics for an
	// Amazon Lookout for Equipment model.
	ModelDiagnosticsOutputConfiguration *ModelDiagnosticsOutputConfiguration

	// The name of the machine learning model.
	ModelName *string

	// Provides a quality assessment for a model that uses labels. If Lookout for
	// Equipment determines that the model quality is poor based on training metrics,
	// the value is POOR_QUALITY_DETECTED . Otherwise, the value is
	// QUALITY_THRESHOLD_MET .
	//
	// If the model is unlabeled, the model quality can't be assessed and the value of
	// ModelQuality is CANNOT_DETERMINE_QUALITY . In this situation, you can get a
	// model quality assessment by adding labels to the input dataset and retraining
	// the model.
	//
	// For information about using labels with your models, see [Understanding labeling].
	//
	// For information about improving the quality of a model, see [Best practices with Amazon Lookout for Equipment].
	//
	// [Best practices with Amazon Lookout for Equipment]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html
	// [Understanding labeling]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html
	ModelQuality ModelQuality

	// Indicates the date that the next scheduled retraining run will start on.
	// Lookout for Equipment truncates the time you provide to [the nearest UTC day].
	//
	// [the nearest UTC day]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp
	NextScheduledRetrainingStartDate *time.Time

	// Indicates the status of the retraining scheduler.
	RetrainingSchedulerStatus RetrainingSchedulerStatus

	// Indicates the status of the machine learning model.
	Status ModelStatus
	// contains filtered or unexported fields
}

Provides information about the specified machine learning model, including dataset and model names and ARNs, as well as status.

type ModelVersionSourceType 

type ModelVersionSourceType string
const (
	ModelVersionSourceTypeTraining   ModelVersionSourceType = "TRAINING"
	ModelVersionSourceTypeRetraining ModelVersionSourceType = "RETRAINING"
	ModelVersionSourceTypeImport     ModelVersionSourceType = "IMPORT"
)

Enum values for ModelVersionSourceType

func (ModelVersionSourceType) Values 

func (ModelVersionSourceType) Values() []ModelVersionSourceType

Values returns all known values for ModelVersionSourceType. 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 ModelVersionStatus 

type ModelVersionStatus string
const (
	ModelVersionStatusInProgress       ModelVersionStatus = "IN_PROGRESS"
	ModelVersionStatusSuccess          ModelVersionStatus = "SUCCESS"
	ModelVersionStatusFailed           ModelVersionStatus = "FAILED"
	ModelVersionStatusImportInProgress ModelVersionStatus = "IMPORT_IN_PROGRESS"
	ModelVersionStatusCanceled         ModelVersionStatus = "CANCELED"
)

Enum values for ModelVersionStatus

func (ModelVersionStatus) Values 

func (ModelVersionStatus) Values() []ModelVersionStatus

Values returns all known values for ModelVersionStatus. 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 ModelVersionSummary 

type ModelVersionSummary struct {

	// The time when this model version was created.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the model that this model version is a
	// version of.
	ModelArn *string

	// The name of the model that this model version is a version of.
	ModelName *string

	// Provides a quality assessment for a model that uses labels. If Lookout for
	// Equipment determines that the model quality is poor based on training metrics,
	// the value is POOR_QUALITY_DETECTED . Otherwise, the value is
	// QUALITY_THRESHOLD_MET .
	//
	// If the model is unlabeled, the model quality can't be assessed and the value of
	// ModelQuality is CANNOT_DETERMINE_QUALITY . In this situation, you can get a
	// model quality assessment by adding labels to the input dataset and retraining
	// the model.
	//
	// For information about improving the quality of a model, see [Best practices with Amazon Lookout for Equipment].
	//
	// [Best practices with Amazon Lookout for Equipment]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html
	ModelQuality ModelQuality

	// The version of the model.
	ModelVersion *int64

	// The Amazon Resource Name (ARN) of the model version.
	ModelVersionArn *string

	// Indicates how this model version was generated.
	SourceType ModelVersionSourceType

	// The current status of the model version.
	Status ModelVersionStatus
	// contains filtered or unexported fields
}

Contains information about the specific model version.

type MonotonicValues 

type MonotonicValues struct {

	//  Indicates whether there is a potential data issue related to having monotonic
	// values.
	//
	// This member is required.
	Status StatisticalIssueStatus

	//  Indicates the monotonicity of values. Can be INCREASING, DECREASING, or
	// STATIC.
	Monotonicity Monotonicity
	// contains filtered or unexported fields
}

Entity that comprises information on monotonic values in the data.

type Monotonicity 

type Monotonicity string
const (
	MonotonicityDecreasing Monotonicity = "DECREASING"
	MonotonicityIncreasing Monotonicity = "INCREASING"
	MonotonicityStatic     Monotonicity = "STATIC"
)

Enum values for Monotonicity

func (Monotonicity) Values 

func (Monotonicity) Values() []Monotonicity

Values returns all known values for Monotonicity. 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 MultipleOperatingModes 

type MultipleOperatingModes struct {

	//  Indicates whether there is a potential data issue related to having multiple
	// operating modes.
	//
	// This member is required.
	Status StatisticalIssueStatus
	// contains filtered or unexported fields
}

Entity that comprises information on operating modes in data.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}
The resource requested could not be found. Verify the resource ID and retry

your request.

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 RetrainingSchedulerStatus 

type RetrainingSchedulerStatus string
const (
	RetrainingSchedulerStatusPending  RetrainingSchedulerStatus = "PENDING"
	RetrainingSchedulerStatusRunning  RetrainingSchedulerStatus = "RUNNING"
	RetrainingSchedulerStatusStopping RetrainingSchedulerStatus = "STOPPING"
	RetrainingSchedulerStatusStopped  RetrainingSchedulerStatus = "STOPPED"
)

Enum values for RetrainingSchedulerStatus

func (RetrainingSchedulerStatus) Values 

func (RetrainingSchedulerStatus) Values() []RetrainingSchedulerStatus

Values returns all known values for RetrainingSchedulerStatus. 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 RetrainingSchedulerSummary 

type RetrainingSchedulerSummary struct {

	// The number of past days of data used for retraining.
	LookbackWindow *string

	// The ARN of the model that the retraining scheduler is attached to.
	ModelArn *string

	// The name of the model that the retraining scheduler is attached to.
	ModelName *string

	// The frequency at which the model retraining is set. This follows the [ISO 8601]
	// guidelines.
	//
	// [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601#Durations
	RetrainingFrequency *string

	// The start date for the retraining scheduler. Lookout for Equipment truncates
	// the time you provide to the nearest UTC day.
	RetrainingStartDate *time.Time

	// The status of the retraining scheduler.
	Status RetrainingSchedulerStatus
	// contains filtered or unexported fields
}

Provides information about the specified retraining scheduler, including model name, status, start date, frequency, and lookback window.

type S3Object 

type S3Object struct {

	// The name of the specific S3 bucket.
	//
	// This member is required.
	Bucket *string

	// The Amazon Web Services Key Management Service (KMS key) key being used to
	// encrypt the S3 object. Without this key, data in the bucket is not accessible.
	//
	// This member is required.
	Key *string
	// contains filtered or unexported fields
}

Contains information about an S3 bucket.

type SensorStatisticsSummary 

type SensorStatisticsSummary struct {

	//  Parameter that describes potential risk about whether data associated with the
	// sensor is categorical.
	CategoricalValues *CategoricalValues

	//  Name of the component to which the particular sensor belongs for which the
	// statistics belong to.
	ComponentName *string

	//  Indicates the time reference to indicate the end of valid data associated with
	// the sensor that the statistics belong to.
	DataEndTime *time.Time

	//  Parameter that indicates whether data exists for the sensor that the
	// statistics belong to.
	DataExists bool

	//  Indicates the time reference to indicate the beginning of valid data
	// associated with the sensor that the statistics belong to.
	DataStartTime *time.Time

	//  Parameter that describes the total number of duplicate timestamp records
	// associated with the sensor that the statistics belong to.
	DuplicateTimestamps *CountPercent

	//  Parameter that describes the total number of invalid date entries associated
	// with the sensor that the statistics belong to.
	InvalidDateEntries *CountPercent

	//  Parameter that describes the total number of, and percentage of, values that
	// are invalid for the sensor that the statistics belong to.
	InvalidValues *CountPercent

	//  Parameter that describes potential risk about whether data associated with the
	// sensor contains one or more large gaps between consecutive timestamps.
	LargeTimestampGaps *LargeTimestampGaps

	//  Parameter that describes the total number of, and percentage of, values that
	// are missing for the sensor that the statistics belong to.
	MissingValues *CountPercent

	//  Parameter that describes potential risk about whether data associated with the
	// sensor is mostly monotonic.
	MonotonicValues *MonotonicValues

	//  Parameter that describes potential risk about whether data associated with the
	// sensor has more than one operating mode.
	MultipleOperatingModes *MultipleOperatingModes

	//  Name of the sensor that the statistics belong to.
	SensorName *string
	// contains filtered or unexported fields
}
Summary of ingestion statistics like whether data exists, number of missing

values, number of invalid values and so on related to the particular sensor.

type SensorsWithShortDateRange 

type SensorsWithShortDateRange struct {

	//  Indicates the number of sensors that have less than 14 days of data.
	//
	// This member is required.
	AffectedSensorCount *int32
	// contains filtered or unexported fields
}

Entity that comprises information on sensors that have shorter date range.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Resource limitations have been exceeded.

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 StatisticalIssueStatus 

type StatisticalIssueStatus string
const (
	StatisticalIssueStatusPotentialIssueDetected StatisticalIssueStatus = "POTENTIAL_ISSUE_DETECTED"
	StatisticalIssueStatusNoIssueDetected        StatisticalIssueStatus = "NO_ISSUE_DETECTED"
)

Enum values for StatisticalIssueStatus

func (StatisticalIssueStatus) Values 

func (StatisticalIssueStatus) Values() []StatisticalIssueStatus

Values returns all known values for StatisticalIssueStatus. 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 Tag 

type Tag struct {

	// The key for the specified tag.
	//
	// This member is required.
	Key *string

	// The value for the specified tag.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A tag is a key-value pair that can be added to a resource as metadata.

type TargetSamplingRate 

type TargetSamplingRate string
const (
	TargetSamplingRatePt1s  TargetSamplingRate = "PT1S"
	TargetSamplingRatePt5s  TargetSamplingRate = "PT5S"
	TargetSamplingRatePt10s TargetSamplingRate = "PT10S"
	TargetSamplingRatePt15s TargetSamplingRate = "PT15S"
	TargetSamplingRatePt30s TargetSamplingRate = "PT30S"
	TargetSamplingRatePt1m  TargetSamplingRate = "PT1M"
	TargetSamplingRatePt5m  TargetSamplingRate = "PT5M"
	TargetSamplingRatePt10m TargetSamplingRate = "PT10M"
	TargetSamplingRatePt15m TargetSamplingRate = "PT15M"
	TargetSamplingRatePt30m TargetSamplingRate = "PT30M"
	TargetSamplingRatePt1h  TargetSamplingRate = "PT1H"
)

Enum values for TargetSamplingRate

func (TargetSamplingRate) Values 

func (TargetSamplingRate) Values() []TargetSamplingRate

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

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

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

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

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnsupportedTimestamps 

type UnsupportedTimestamps struct {

	//  Indicates the total number of unsupported timestamps across the ingested data.
	//
	// This member is required.
	TotalNumberOfUnsupportedTimestamps *int32
	// contains filtered or unexported fields
}
Entity that comprises information abount unsupported timestamps in the

dataset.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}
The input fails to satisfy constraints specified by Amazon Lookout for

Equipment or a related Amazon Web Services service that's being utilized.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

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

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

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.