lookoutequipment

package module
v1.30.6 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 47 Imported by: 7

Documentation

Overview

Package lookoutequipment provides the API client, operations, and parameter types for Amazon Lookout for Equipment.

Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify anomalies in machines from sensor data for use in predictive maintenance.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-12-15"
View Source 
const ServiceID = "LookoutEquipment"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.18.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.21.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.21.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.21.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.21.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

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

Client provides the API client to make operations call for Amazon Lookout for Equipment.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateDataset 

func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error)

Creates a container for a collection of data being ingested for analysis. The dataset contains the metadata describing where the data is and what the data actually looks like. For example, it contains the location of the data source, the data schema, and other information. A dataset also contains any tags associated with the ingested data.

func (*Client) CreateInferenceScheduler 

func (c *Client) CreateInferenceScheduler(ctx context.Context, params *CreateInferenceSchedulerInput, optFns ...func(*Options)) (*CreateInferenceSchedulerOutput, error)
Creates a scheduled inference. Scheduling an inference is setting up a

continuous real-time inference plan to analyze new measurement data. When setting up the schedule, you provide an S3 bucket location for the input data, assign it a delimiter between separate entries in the data, set an offset delay if desired, and set the frequency of inferencing. You must also provide an S3 bucket location for the output data.

func (*Client) CreateLabel added in v1.15.0 

func (c *Client) CreateLabel(ctx context.Context, params *CreateLabelInput, optFns ...func(*Options)) (*CreateLabelOutput, error)

Creates a label for an event.

func (*Client) CreateLabelGroup added in v1.15.0 

func (c *Client) CreateLabelGroup(ctx context.Context, params *CreateLabelGroupInput, optFns ...func(*Options)) (*CreateLabelGroupOutput, error)

Creates a group of labels.

func (*Client) CreateModel 

func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optFns ...func(*Options)) (*CreateModelOutput, error)

Creates a machine learning model for data inference.

A machine-learning (ML) model is a mathematical model that finds patterns in your data. In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal behavior that could be potential equipment failure (or maintenance events). The models are made by analyzing normal data and abnormalities in machine behavior that have already occurred.

Your model is trained using a portion of the data from your dataset and uses that data to learn patterns of normal behavior and abnormal patterns that lead to equipment failure. Another portion of the data is used to evaluate the model's accuracy.

func (*Client) CreateRetrainingScheduler added in v1.19.0 

func (c *Client) CreateRetrainingScheduler(ctx context.Context, params *CreateRetrainingSchedulerInput, optFns ...func(*Options)) (*CreateRetrainingSchedulerOutput, error)

Creates a retraining scheduler on the specified model.

func (*Client) DeleteDataset 

func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error)
Deletes a dataset and associated artifacts. The operation will check to see if

any inference scheduler or data ingestion job is currently using the dataset, and if there isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted. This does not affect any models that used this dataset for training and evaluation, but does prevent it from being used in the future.

func (*Client) DeleteInferenceScheduler 

func (c *Client) DeleteInferenceScheduler(ctx context.Context, params *DeleteInferenceSchedulerInput, optFns ...func(*Options)) (*DeleteInferenceSchedulerOutput, error)

Deletes an inference scheduler that has been set up. Prior inference results will not be deleted.

func (*Client) DeleteLabel added in v1.15.0 

func (c *Client) DeleteLabel(ctx context.Context, params *DeleteLabelInput, optFns ...func(*Options)) (*DeleteLabelOutput, error)

Deletes a label.

func (*Client) DeleteLabelGroup added in v1.15.0 

func (c *Client) DeleteLabelGroup(ctx context.Context, params *DeleteLabelGroupInput, optFns ...func(*Options)) (*DeleteLabelGroupOutput, error)

Deletes a group of labels.

func (*Client) DeleteModel 

func (c *Client) DeleteModel(ctx context.Context, params *DeleteModelInput, optFns ...func(*Options)) (*DeleteModelOutput, error)

Deletes a machine learning model currently available for Amazon Lookout for Equipment. This will prevent it from being used with an inference scheduler, even one that is already set up.

func (*Client) DeleteResourcePolicy added in v1.18.0 

func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error)

Deletes the resource policy attached to the resource.

func (*Client) DeleteRetrainingScheduler added in v1.19.0 

func (c *Client) DeleteRetrainingScheduler(ctx context.Context, params *DeleteRetrainingSchedulerInput, optFns ...func(*Options)) (*DeleteRetrainingSchedulerOutput, error)

Deletes a retraining scheduler from a model. The retraining scheduler must be in the STOPPED status.

func (*Client) DescribeDataIngestionJob 

func (c *Client) DescribeDataIngestionJob(ctx context.Context, params *DescribeDataIngestionJobInput, optFns ...func(*Options)) (*DescribeDataIngestionJobOutput, error)

Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.

func (*Client) DescribeDataset 

func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error)

Provides a JSON description of the data in each time series dataset, including names, column names, and data types.

func (*Client) DescribeInferenceScheduler 

func (c *Client) DescribeInferenceScheduler(ctx context.Context, params *DescribeInferenceSchedulerInput, optFns ...func(*Options)) (*DescribeInferenceSchedulerOutput, error)
Specifies information about the inference scheduler being used, including

name, model, status, and associated metadata

func (*Client) DescribeLabel added in v1.15.0 

func (c *Client) DescribeLabel(ctx context.Context, params *DescribeLabelInput, optFns ...func(*Options)) (*DescribeLabelOutput, error)

Returns the name of the label.

func (*Client) DescribeLabelGroup added in v1.15.0 

func (c *Client) DescribeLabelGroup(ctx context.Context, params *DescribeLabelGroupInput, optFns ...func(*Options)) (*DescribeLabelGroupOutput, error)

Returns information about the label group.

func (*Client) DescribeModel 

func (c *Client) DescribeModel(ctx context.Context, params *DescribeModelInput, optFns ...func(*Options)) (*DescribeModelOutput, error)

Provides a JSON containing the overall information about a specific machine learning model, including model name and ARN, dataset, training and evaluation information, status, and so on.

func (*Client) DescribeModelVersion added in v1.18.0 

func (c *Client) DescribeModelVersion(ctx context.Context, params *DescribeModelVersionInput, optFns ...func(*Options)) (*DescribeModelVersionOutput, error)

Retrieves information about a specific machine learning model version.

func (*Client) DescribeResourcePolicy added in v1.18.0 

func (c *Client) DescribeResourcePolicy(ctx context.Context, params *DescribeResourcePolicyInput, optFns ...func(*Options)) (*DescribeResourcePolicyOutput, error)

Provides the details of a resource policy attached to a resource.

func (*Client) DescribeRetrainingScheduler added in v1.19.0 

func (c *Client) DescribeRetrainingScheduler(ctx context.Context, params *DescribeRetrainingSchedulerInput, optFns ...func(*Options)) (*DescribeRetrainingSchedulerOutput, error)

Provides a description of the retraining scheduler, including information such as the model name and retraining parameters.

func (*Client) ImportDataset added in v1.18.0 

func (c *Client) ImportDataset(ctx context.Context, params *ImportDatasetInput, optFns ...func(*Options)) (*ImportDatasetOutput, error)

Imports a dataset.

func (*Client) ImportModelVersion added in v1.18.0 

func (c *Client) ImportModelVersion(ctx context.Context, params *ImportModelVersionInput, optFns ...func(*Options)) (*ImportModelVersionOutput, error)

Imports a model that has been trained successfully.

func (*Client) ListDataIngestionJobs 

func (c *Client) ListDataIngestionJobs(ctx context.Context, params *ListDataIngestionJobsInput, optFns ...func(*Options)) (*ListDataIngestionJobsOutput, error)

Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.

func (*Client) ListDatasets 

func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error)

Lists all datasets currently available in your account, filtering on the dataset name.

func (*Client) ListInferenceEvents added in v1.14.0 

func (c *Client) ListInferenceEvents(ctx context.Context, params *ListInferenceEventsInput, optFns ...func(*Options)) (*ListInferenceEventsOutput, error)
Lists all inference events that have been found for the specified inference

scheduler.

func (*Client) ListInferenceExecutions 

func (c *Client) ListInferenceExecutions(ctx context.Context, params *ListInferenceExecutionsInput, optFns ...func(*Options)) (*ListInferenceExecutionsOutput, error)
Lists all inference executions that have been performed by the specified

inference scheduler.

func (*Client) ListInferenceSchedulers 

func (c *Client) ListInferenceSchedulers(ctx context.Context, params *ListInferenceSchedulersInput, optFns ...func(*Options)) (*ListInferenceSchedulersOutput, error)

Retrieves a list of all inference schedulers currently available for your account.

func (*Client) ListLabelGroups added in v1.15.0 

func (c *Client) ListLabelGroups(ctx context.Context, params *ListLabelGroupsInput, optFns ...func(*Options)) (*ListLabelGroupsOutput, error)

Returns a list of the label groups.

func (*Client) ListLabels added in v1.15.0 

func (c *Client) ListLabels(ctx context.Context, params *ListLabelsInput, optFns ...func(*Options)) (*ListLabelsOutput, error)

Provides a list of labels.

func (*Client) ListModelVersions added in v1.18.0 

func (c *Client) ListModelVersions(ctx context.Context, params *ListModelVersionsInput, optFns ...func(*Options)) (*ListModelVersionsOutput, error)

Generates a list of all model versions for a given model, including the model version, model version ARN, and status. To list a subset of versions, use the MaxModelVersion and MinModelVersion fields.

func (*Client) ListModels 

func (c *Client) ListModels(ctx context.Context, params *ListModelsInput, optFns ...func(*Options)) (*ListModelsOutput, error)

Generates a list of all models in the account, including model name and ARN, dataset, and status.

func (*Client) ListRetrainingSchedulers added in v1.19.0 

func (c *Client) ListRetrainingSchedulers(ctx context.Context, params *ListRetrainingSchedulersInput, optFns ...func(*Options)) (*ListRetrainingSchedulersOutput, error)

Lists all retraining schedulers in your account, filtering by model name prefix and status.

func (*Client) ListSensorStatistics added in v1.13.0 

func (c *Client) ListSensorStatistics(ctx context.Context, params *ListSensorStatisticsInput, optFns ...func(*Options)) (*ListSensorStatisticsOutput, error)
Lists statistics about the data collected for each of the sensors that have

been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists all the tags for a specified resource, including key and value.

func (*Client) Options added in v1.22.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutResourcePolicy added in v1.18.0 

func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error)

Creates a resource control policy for a given resource.

func (*Client) StartDataIngestionJob 

func (c *Client) StartDataIngestionJob(ctx context.Context, params *StartDataIngestionJobInput, optFns ...func(*Options)) (*StartDataIngestionJobOutput, error)

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.

func (*Client) StartInferenceScheduler 

func (c *Client) StartInferenceScheduler(ctx context.Context, params *StartInferenceSchedulerInput, optFns ...func(*Options)) (*StartInferenceSchedulerOutput, error)

Starts an inference scheduler.

func (*Client) StartRetrainingScheduler added in v1.19.0 

func (c *Client) StartRetrainingScheduler(ctx context.Context, params *StartRetrainingSchedulerInput, optFns ...func(*Options)) (*StartRetrainingSchedulerOutput, error)

Starts a retraining scheduler.

func (*Client) StopInferenceScheduler 

func (c *Client) StopInferenceScheduler(ctx context.Context, params *StopInferenceSchedulerInput, optFns ...func(*Options)) (*StopInferenceSchedulerOutput, error)

Stops an inference scheduler.

func (*Client) StopRetrainingScheduler added in v1.19.0 

func (c *Client) StopRetrainingScheduler(ctx context.Context, params *StopRetrainingSchedulerInput, optFns ...func(*Options)) (*StopRetrainingSchedulerOutput, error)

Stops a retraining scheduler.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Associates a given tag to a resource in your account. A tag is a key-value pair which can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your resources as well as helping you to search and filter by tag. Multiple tags can be added to a resource, either when you create it, or later. Up to 50 tags can be associated with each resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes a specific tag from a given resource. The tag is specified by its key.

func (*Client) UpdateActiveModelVersion added in v1.18.0 

func (c *Client) UpdateActiveModelVersion(ctx context.Context, params *UpdateActiveModelVersionInput, optFns ...func(*Options)) (*UpdateActiveModelVersionOutput, error)

Sets the active model version for a given machine learning model.

func (*Client) UpdateInferenceScheduler 

func (c *Client) UpdateInferenceScheduler(ctx context.Context, params *UpdateInferenceSchedulerInput, optFns ...func(*Options)) (*UpdateInferenceSchedulerOutput, error)

Updates an inference scheduler.

func (*Client) UpdateLabelGroup added in v1.15.0 

func (c *Client) UpdateLabelGroup(ctx context.Context, params *UpdateLabelGroupInput, optFns ...func(*Options)) (*UpdateLabelGroupOutput, error)

Updates the label group.

func (*Client) UpdateModel added in v1.19.0 

func (c *Client) UpdateModel(ctx context.Context, params *UpdateModelInput, optFns ...func(*Options)) (*UpdateModelOutput, error)

Updates a model in the account.

func (*Client) UpdateRetrainingScheduler added in v1.19.0 

func (c *Client) UpdateRetrainingScheduler(ctx context.Context, params *UpdateRetrainingSchedulerInput, optFns ...func(*Options)) (*UpdateRetrainingSchedulerOutput, error)

Updates a retraining scheduler.

type CreateDatasetInput 

type CreateDatasetInput struct {

	//  A unique identifier for the request. If you do not set the client request
	// token, Amazon Lookout for Equipment generates one.
	//
	// This member is required.
	ClientToken *string

	// The name of the dataset being created.
	//
	// This member is required.
	DatasetName *string

	// A JSON description of the data that is in each time series dataset, including
	// names, column names, and data types.
	DatasetSchema *types.DatasetSchema

	// Provides the identifier of the KMS key used to encrypt dataset data by Amazon
	// Lookout for Equipment.
	ServerSideKmsKeyId *string

	// Any tags associated with the ingested data described in the dataset.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDatasetOutput 

type CreateDatasetOutput struct {

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

	// The name of the dataset being created.
	DatasetName *string

	// Indicates the status of the CreateDataset operation.
	Status types.DatasetStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateInferenceSchedulerInput 

type CreateInferenceSchedulerInput struct {

	//  A unique identifier for the request. If you do not set the client request
	// token, Amazon Lookout for Equipment generates one.
	//
	// This member is required.
	ClientToken *string

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

	// Specifies configuration information for the output results for the inference
	// scheduler, including the S3 location for the output.
	//
	// This member is required.
	DataOutputConfiguration *types.InferenceOutputConfiguration

	//  How often data is uploaded to the source Amazon S3 bucket for the input data.
	// The value chosen 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 runs inference on your data.
	//
	// For more information, see [Understanding the inference process].
	//
	// [Understanding the inference process]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html
	//
	// This member is required.
	DataUploadFrequency types.DataUploadFrequency

	// The name of the inference scheduler being created.
	//
	// This member is required.
	InferenceSchedulerName *string

	// The name of the previously trained machine learning model being used to create
	// the inference scheduler.
	//
	// This member is required.
	ModelName *string

	// The Amazon Resource Name (ARN) of a role with permission to access the data
	// source being used for the inference.
	//
	// This member is required.
	RoleArn *string

	// The interval (in minutes) of planned delay at the start of each inference
	// segment. For example, if inference is set to run every ten minutes, the delay is
	// set to five minutes and the time is 09:08. The inference scheduler will wake up
	// at the configured interval (which, without a delay configured, would be 09:10)
	// plus the additional five minute delay time (so 09:15) to check your Amazon S3
	// bucket. The delay provides a buffer for you to upload data at the same
	// frequency, so that you don't have to stop and restart the scheduler when
	// uploading new data.
	//
	// For more information, see [Understanding the inference process].
	//
	// [Understanding the inference process]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html
	DataDelayOffsetInMinutes *int64

	// Provides the identifier of the KMS key used to encrypt inference scheduler data
	// by Amazon Lookout for Equipment.
	ServerSideKmsKeyId *string

	// Any tags associated with the inference scheduler.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateInferenceSchedulerOutput 

type CreateInferenceSchedulerOutput struct {

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

	// The name of inference scheduler being created.
	InferenceSchedulerName *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 types.ModelQuality

	// Indicates the status of the CreateInferenceScheduler operation.
	Status types.InferenceSchedulerStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLabelGroupInput added in v1.15.0 

type CreateLabelGroupInput struct {

	//  A unique identifier for the request to create a label group. If you do not set
	// the client request token, Lookout for Equipment generates one.
	//
	// This member is required.
	ClientToken *string

	//  Names a group of labels.
	//
	// Data in this field will be retained for service usage. Follow best practices
	// for the security of your data.
	//
	// This member is required.
	LabelGroupName *string

	//  The acceptable fault codes (indicating the type of anomaly associated with the
	// label) that can be used with this label group.
	//
	// Data in this field will be retained for service usage. Follow best practices
	// for the security of your data.
	FaultCodes []string

	//  Tags that provide metadata about the label group you are creating.
	//
	// Data in this field will be retained for service usage. Follow best practices
	// for the security of your data.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateLabelGroupOutput added in v1.15.0 

type CreateLabelGroupOutput struct {

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

	//  The name of the label group that you have created. Data in this field will be
	// retained for service usage. Follow best practices for the security of your data.
	LabelGroupName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLabelInput added in v1.15.0 

type CreateLabelInput struct {

	//  A unique identifier for the request to create a label. If you do not set the
	// client request token, Lookout for Equipment generates one.
	//
	// This member is required.
	ClientToken *string

	//  The end time of the labeled event.
	//
	// This member is required.
	EndTime *time.Time

	//  The name of a group of labels.
	//
	// Data in this field will be retained for service usage. Follow best practices
	// for the security of your data.
	//
	// This member is required.
	LabelGroupName *string

	//  Indicates whether a labeled event represents an anomaly.
	//
	// This member is required.
	Rating types.LabelRating

	//  The start time of the labeled event.
	//
	// This member is required.
	StartTime *time.Time

	//  Indicates that a label pertains to a particular piece of equipment.
	//
	// Data in this field will be retained for service usage. Follow best practices
	// for the security of your data.
	Equipment *string

	//  Provides additional information about the label. The fault code must be
	// defined in the FaultCodes attribute of the label group.
	//
	// Data in this field will be retained for service usage. Follow best practices
	// for the security of your data.
	FaultCode *string

	//  Metadata providing additional information about the label.
	//
	// Data in this field will be retained for service usage. Follow best practices
	// for the security of your data.
	Notes *string
	// contains filtered or unexported fields
}

type CreateLabelOutput added in v1.15.0 

type CreateLabelOutput struct {

	//  The ID of the label that you have created.
	LabelId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateModelInput 

type CreateModelInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Lookout for Equipment generates one.
	//
	// This member is required.
	ClientToken *string

	// The name of the dataset for the machine learning model being created.
	//
	// This member is required.
	DatasetName *string

	// The name for the machine learning model to be created.
	//
	// This member is required.
	ModelName *string

	// 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
	DataPreProcessingConfiguration *types.DataPreProcessingConfiguration

	// The data schema for the machine learning model being created.
	DatasetSchema *types.DatasetSchema

	//  Indicates the time reference in the dataset that should be used to end the
	// subset of evaluation data for the machine learning model.
	EvaluationDataEndTime *time.Time

	// Indicates the time reference in the dataset that should be used to begin the
	// subset of evaluation data for the machine learning model.
	EvaluationDataStartTime *time.Time

	// The input configuration for the labels being used for the machine learning
	// model that's being created.
	LabelsInputConfiguration *types.LabelsInputConfiguration

	// The Amazon S3 location where you want Amazon Lookout for Equipment to save the
	// pointwise model diagnostics.
	//
	// You must also specify the RoleArn request parameter.
	ModelDiagnosticsOutputConfiguration *types.ModelDiagnosticsOutputConfiguration

	// Indicates that the asset associated with this sensor has been shut off. As long
	// as this condition is met, Lookout for Equipment will not use data from this
	// asset for training, evaluation, or inference.
	OffCondition *string

	//  The Amazon Resource Name (ARN) of a role with permission to access the data
	// source being used to create the machine learning model.
	RoleArn *string

	// Provides the identifier of the KMS key used to encrypt model data by Amazon
	// Lookout for Equipment.
	ServerSideKmsKeyId *string

	//  Any tags associated with the machine learning model being created.
	Tags []types.Tag

	// Indicates the time reference in the dataset that should be used to end the
	// subset of training data for the machine learning model.
	TrainingDataEndTime *time.Time

	// Indicates the time reference in the dataset that should be used to begin the
	// subset of training data for the machine learning model.
	TrainingDataStartTime *time.Time
	// contains filtered or unexported fields
}

type CreateModelOutput 

type CreateModelOutput struct {

	// The Amazon Resource Name (ARN) of the model being created.
	ModelArn *string

	// Indicates the status of the CreateModel operation.
	Status types.ModelStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRetrainingSchedulerInput added in v1.19.0 

type CreateRetrainingSchedulerInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Lookout for Equipment generates one.
	//
	// This member is required.
	ClientToken *string

	// The number of past days of data that will be used for retraining.
	//
	// This member is required.
	LookbackWindow *string

	// The name of the model to add the retraining scheduler to.
	//
	// This member is required.
	ModelName *string

	// This parameter uses the [ISO 8601] standard to set the frequency at which you want
	// retraining to occur in terms of Years, Months, and/or Days (note: other
	// parameters like Time are not currently supported). The minimum value is 30 days
	// (P30D) and the maximum value is 1 year (P1Y). For example, the following values
	// are valid:
	//
	//   - P3M15D – Every 3 months and 15 days
	//
	//   - P2M – Every 2 months
	//
	//   - P150D – Every 150 days
	//
	// [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601#Durations
	//
	// This member is required.
	RetrainingFrequency *string

	// Indicates how the service will use new models. In MANAGED mode, new models will
	// automatically be used for inference if they have better performance than the
	// current model. In MANUAL mode, the new models will not be used [until they are manually activated].
	//
	// [until they are manually activated]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation
	PromoteMode types.ModelPromoteMode

	// The start date for the retraining scheduler. Lookout for Equipment truncates
	// the time you provide to the nearest UTC day.
	RetrainingStartDate *time.Time
	// contains filtered or unexported fields
}

type CreateRetrainingSchedulerOutput added in v1.19.0 

type CreateRetrainingSchedulerOutput struct {

	// The ARN of the model that you added the retraining scheduler to.
	ModelArn *string

	// The name of the model that you added the retraining scheduler to.
	ModelName *string

	// The status of the retraining scheduler.
	Status types.RetrainingSchedulerStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDatasetInput 

type DeleteDatasetInput struct {

	// The name of the dataset to be deleted.
	//
	// This member is required.
	DatasetName *string
	// contains filtered or unexported fields
}

type DeleteDatasetOutput 

type DeleteDatasetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteInferenceSchedulerInput 

type DeleteInferenceSchedulerInput struct {

	// The name of the inference scheduler to be deleted.
	//
	// This member is required.
	InferenceSchedulerName *string
	// contains filtered or unexported fields
}

type DeleteInferenceSchedulerOutput 

type DeleteInferenceSchedulerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLabelGroupInput added in v1.15.0 

type DeleteLabelGroupInput struct {

	//  The name of the label group that you want to delete. Data in this field will
	// be retained for service usage. Follow best practices for the security of your
	// data.
	//
	// This member is required.
	LabelGroupName *string
	// contains filtered or unexported fields
}

type DeleteLabelGroupOutput added in v1.15.0 

type DeleteLabelGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLabelInput added in v1.15.0 

type DeleteLabelInput struct {

	//  The name of the label group that contains the label that you want to delete.
	// Data in this field will be retained for service usage. Follow best practices for
	// the security of your data.
	//
	// This member is required.
	LabelGroupName *string

	//  The ID of the label that you want to delete.
	//
	// This member is required.
	LabelId *string
	// contains filtered or unexported fields
}

type DeleteLabelOutput added in v1.15.0 

type DeleteLabelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteModelInput 

type DeleteModelInput struct {

	// The name of the machine learning model to be deleted.
	//
	// This member is required.
	ModelName *string
	// contains filtered or unexported fields
}

type DeleteModelOutput 

type DeleteModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteResourcePolicyInput added in v1.18.0 

type DeleteResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the resource for which the resource policy
	// should be deleted.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type DeleteResourcePolicyOutput added in v1.18.0 

type DeleteResourcePolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRetrainingSchedulerInput added in v1.19.0 

type DeleteRetrainingSchedulerInput struct {

	// The name of the model whose retraining scheduler you want to delete.
	//
	// This member is required.
	ModelName *string
	// contains filtered or unexported fields
}

type DeleteRetrainingSchedulerOutput added in v1.19.0 

type DeleteRetrainingSchedulerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDataIngestionJobInput 

type DescribeDataIngestionJobInput struct {

	// The job ID of the data ingestion job.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeDataIngestionJobOutput 

type DescribeDataIngestionJobOutput struct {

	// The time at which the data ingestion job was created.
	CreatedAt *time.Time

	//  Indicates the latest timestamp corresponding to data that was successfully
	// ingested during this specific ingestion job.
	DataEndTime *time.Time

	//  Gives statistics about a completed ingestion job. These statistics primarily
	// relate to quantifying incorrect data such as MissingCompleteSensorData,
	// MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and
	// DuplicateTimeStamps.
	DataQualitySummary *types.DataQualitySummary

	//  Indicates the earliest timestamp corresponding to data that was successfully
	// ingested during this specific ingestion job.
	DataStartTime *time.Time

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

	// Specifies the reason for failure when a data ingestion job has failed.
	FailedReason *string

	//  Indicates the size of the ingested dataset.
	IngestedDataSize *int64

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

	// Specifies the S3 location configuration for the data input for the data
	// ingestion job.
	IngestionInputConfiguration *types.IngestionInputConfiguration

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

	// The Amazon Resource Name (ARN) of an IAM role with permission to access the
	// data source being ingested.
	RoleArn *string

	// The Amazon Resource Name (ARN) of the source dataset from which the data used
	// for the data ingestion job was imported from.
	SourceDatasetArn *string

	// Indicates the status of the DataIngestionJob operation.
	Status types.IngestionJobStatus

	//  Provides details about status of the ingestion job that is currently in
	// progress.
	StatusDetail *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDatasetInput 

type DescribeDatasetInput struct {

	// The name of the dataset to be described.
	//
	// This member is required.
	DatasetName *string
	// contains filtered or unexported fields
}

type DescribeDatasetOutput 

type DescribeDatasetOutput struct {

	// Specifies the time the dataset was created in Lookout for Equipment.
	CreatedAt *time.Time

	//  Indicates the latest timestamp corresponding to data that was successfully
	// ingested during the most recent ingestion of this particular dataset.
	DataEndTime *time.Time

	//  Gives statistics associated with the given dataset for the latest successful
	// associated ingestion job id. These statistics primarily relate to quantifying
	// incorrect data such as MissingCompleteSensorData, MissingSensorData,
	// UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.
	DataQualitySummary *types.DataQualitySummary

	//  Indicates the earliest timestamp corresponding to data that was successfully
	// ingested during the most recent ingestion of this particular dataset.
	DataStartTime *time.Time

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

	// The name of the dataset being described.
	DatasetName *string

	// IngestedFilesSummary associated with the given dataset for the latest
	// successful associated ingestion job id.
	IngestedFilesSummary *types.IngestedFilesSummary

	// Specifies the S3 location configuration for the data input for the data
	// ingestion job.
	IngestionInputConfiguration *types.IngestionInputConfiguration

	// Specifies the time the dataset was last updated, if it was.
	LastUpdatedAt *time.Time

	//  The Amazon Resource Name (ARN) of the IAM role that you are using for this the
	// data ingestion job.
	RoleArn *string

	// A JSON description of the data that is in each time series dataset, including
	// names, column names, and data types.
	//
	// This value conforms to the media type: application/json
	Schema *string

	// Provides the identifier of the KMS key used to encrypt dataset data by Amazon
	// Lookout for Equipment.
	ServerSideKmsKeyId *string

	// The Amazon Resource Name (ARN) of the source dataset from which the current
	// data being described was imported from.
	SourceDatasetArn *string

	// Indicates the status of the dataset.
	Status types.DatasetStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeInferenceSchedulerInput 

type DescribeInferenceSchedulerInput struct {

	// The name of the inference scheduler being described.
	//
	// This member is required.
	InferenceSchedulerName *string
	// contains filtered or unexported fields
}

type DescribeInferenceSchedulerOutput 

type DescribeInferenceSchedulerOutput struct {

	// Specifies the time at which the inference scheduler was created.
	CreatedAt *time.Time

	//  A period of time (in minutes) by which inference on the data is delayed after
	// the data starts. For instance, if you select an offset delay time of five
	// minutes, 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

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

	//  Specifies information for the output results for the inference scheduler,
	// including the output S3 location.
	DataOutputConfiguration *types.InferenceOutputConfiguration

	// Specifies 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 types.DataUploadFrequency

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

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

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

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

	// The name of the machine learning model of the inference scheduler being
	// described.
	ModelName *string

	//  The Amazon Resource Name (ARN) of a role with permission to access the data
	// source for the inference scheduler being described.
	RoleArn *string

	// Provides the identifier of the KMS key used to encrypt inference scheduler data
	// by Amazon Lookout for Equipment.
	ServerSideKmsKeyId *string

	// Indicates the status of the inference scheduler.
	Status types.InferenceSchedulerStatus

	// Specifies the time at which the inference scheduler was last updated, if it
	// was.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeLabelGroupInput added in v1.15.0 

type DescribeLabelGroupInput struct {

	//  Returns the name of the label group.
	//
	// This member is required.
	LabelGroupName *string
	// contains filtered or unexported fields
}

type DescribeLabelGroupOutput added in v1.15.0 

type DescribeLabelGroupOutput struct {

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

	//  Codes indicating the type of anomaly associated with the labels in the lagbel
	// group.
	FaultCodes []string

	//  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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeLabelInput added in v1.15.0 

type DescribeLabelInput struct {

	//  Returns the name of the group containing the label.
	//
	// This member is required.
	LabelGroupName *string

	//  Returns the ID of the label.
	//
	// This member is required.
	LabelId *string
	// contains filtered or unexported fields
}

type DescribeLabelOutput added in v1.15.0 

type DescribeLabelOutput struct {

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

	//  The end time of the requested 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 requested label group.
	LabelGroupArn *string

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

	//  The ID of the requested label.
	LabelId *string

	// Metadata providing additional information about the label.
	//
	// Data in this field will be retained for service usage. Follow best practices
	// for the security of your data.
	Notes *string

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

	//  The start time of the requested label.
	StartTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeModelInput 

type DescribeModelInput struct {

	// The name of the machine learning model to be described.
	//
	// This member is required.
	ModelName *string
	// contains filtered or unexported fields
}

type DescribeModelOutput 

type DescribeModelOutput struct {

	// Indicates the end time of the inference data that has been accumulated.
	AccumulatedInferenceDataEndTime *time.Time

	// Indicates the start time of the inference data that has been accumulated.
	AccumulatedInferenceDataStartTime *time.Time

	// The name of the model version used by the inference schedular when running a
	// scheduled inference execution.
	ActiveModelVersion *int64

	// The Amazon Resource Name (ARN) of the model version used by the inference
	// scheduler when running a scheduled inference execution.
	ActiveModelVersionArn *string

	// Indicates the time and date at which the machine learning model was created.
	CreatedAt *time.Time

	// 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
	DataPreProcessingConfiguration *types.DataPreProcessingConfiguration

	// The Amazon Resouce Name (ARN) of the dataset used to create the machine
	// learning model being described.
	DatasetArn *string

	// The name of the dataset being used by the machine learning being described.
	DatasetName *string

	//  Indicates the time reference in the dataset that was used to end the subset of
	// evaluation data for the machine learning model.
	EvaluationDataEndTime *time.Time

	//  Indicates the time reference in the dataset that was used to begin the subset
	// of evaluation data for the machine learning model.
	EvaluationDataStartTime *time.Time

	// If the training of the machine learning model failed, this indicates the reason
	// for that failure.
	FailedReason *string

	// The date and time when the import job was completed. This field appears if the
	// active model version was imported.
	ImportJobEndTime *time.Time

	// The date and time when the import job was started. This field appears if the
	// active model version was imported.
	ImportJobStartTime *time.Time

	// Specifies configuration information about the labels input, including its S3
	// location.
	LabelsInputConfiguration *types.LabelsInputConfiguration

	// Indicates the last time the machine learning model was updated. The type of
	// update is not specified.
	LastUpdatedTime *time.Time

	// Indicates the number of days of data used in the most recent scheduled
	// retraining run.
	LatestScheduledRetrainingAvailableDataInDays *int32

	// If the model version was generated by retraining and the training failed, this
	// indicates the reason for that failure.
	LatestScheduledRetrainingFailedReason *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 types.ModelVersionStatus

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

	// Configuration information for the model's pointwise model diagnostics.
	ModelDiagnosticsOutputConfiguration *types.ModelDiagnosticsOutputConfiguration

	// The Model Metrics show an aggregated summary of the model's performance within
	// the evaluation time range. This is the JSON content of the metrics created when
	// evaluating the model.
	//
	// This value conforms to the media type: application/json
	ModelMetrics *string

	// The name of the machine learning model being described.
	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 types.ModelQuality

	// The date the active model version was activated.
	ModelVersionActivatedAt *time.Time

	// Indicates the date and time that the next scheduled retraining run will start
	// on. Lookout for Equipment truncates the time you provide to the nearest UTC day.
	NextScheduledRetrainingStartDate *time.Time

	// Indicates that the asset associated with this sensor has been shut off. As long
	// as this condition is met, Lookout for Equipment will not use data from this
	// asset for training, evaluation, or inference.
	OffCondition *string

	// The model version that was set as the active model version prior to the current
	// active model version.
	PreviousActiveModelVersion *int64

	// The ARN of the model version that was set as the active model version prior to
	// the current active model version.
	PreviousActiveModelVersionArn *string

	// The date and time when the previous active model version was activated.
	PreviousModelVersionActivatedAt *time.Time

	// If the model version was retrained, this field shows a summary of the
	// performance of the prior model on the new training range. You can use the
	// information in this JSON-formatted object to compare the new model version and
	// the prior model version.
	//
	// This value conforms to the media type: application/json
	PriorModelMetrics *string

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

	//  The Amazon Resource Name (ARN) of a role with permission to access the data
	// source for the machine learning model being described.
	RoleArn *string

	// A JSON description of the data that is in each time series dataset, including
	// names, column names, and data types.
	//
	// This value conforms to the media type: application/json
	Schema *string

	// Provides the identifier of the KMS key used to encrypt model data by Amazon
	// Lookout for Equipment.
	ServerSideKmsKeyId *string

	// The Amazon Resource Name (ARN) of the source model version. This field appears
	// if the active model version was imported.
	SourceModelVersionArn *string

	// Specifies the current status of the model being described. Status describes the
	// status of the most recent action of the model.
	Status types.ModelStatus

	//  Indicates the time reference in the dataset that was used to end the subset of
	// training data for the machine learning model.
	TrainingDataEndTime *time.Time

	//  Indicates the time reference in the dataset that was used to begin the subset
	// of training data for the machine learning model.
	TrainingDataStartTime *time.Time

	// Indicates the time at which the training of the machine learning model was
	// completed.
	TrainingExecutionEndTime *time.Time

	// Indicates the time at which the training of the machine learning model began.
	TrainingExecutionStartTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeModelVersionInput added in v1.18.0 

type DescribeModelVersionInput struct {

	// The name of the machine learning model that this version belongs to.
	//
	// This member is required.
	ModelName *string

	// The version of the machine learning model.
	//
	// This member is required.
	ModelVersion *int64
	// contains filtered or unexported fields
}

type DescribeModelVersionOutput added in v1.18.0 

type DescribeModelVersionOutput struct {

	// Indicates whether the model version was promoted to be the active version after
	// retraining or if there was an error with or cancellation of the retraining.
	AutoPromotionResult types.AutoPromotionResult

	// Indicates the reason for the AutoPromotionResult . For example, a model might
	// not be promoted if its performance was worse than the active version, if there
	// was an error during training, or if the retraining scheduler was using MANUAL
	// promote mode. The model will be promoted in MANAGED promote mode if the
	// performance is better than the previous model.
	AutoPromotionResultReason *string

	// Indicates the time and date at which the machine learning model version was
	// created.
	CreatedAt *time.Time

	// 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
	DataPreProcessingConfiguration *types.DataPreProcessingConfiguration

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

	// The name of the dataset used to train the model version.
	DatasetName *string

	// The date on which the data in the evaluation set began being gathered. If you
	// imported the version, this is the date that the evaluation set data in the
	// source version finished being gathered.
	EvaluationDataEndTime *time.Time

	// The date on which the data in the evaluation set began being gathered. If you
	// imported the version, this is the date that the evaluation set data in the
	// source version began being gathered.
	EvaluationDataStartTime *time.Time

	// The failure message if the training of the model version failed.
	FailedReason *string

	// The date and time when the import job completed. This field appears if the
	// model version was imported.
	ImportJobEndTime *time.Time

	// The date and time when the import job began. This field appears if the model
	// version was imported.
	ImportJobStartTime *time.Time

	// The size in bytes of the imported data. This field appears if the model version
	// was imported.
	ImportedDataSizeInBytes *int64

	// Contains the configuration information for the S3 location being used to hold
	// label data.
	LabelsInputConfiguration *types.LabelsInputConfiguration

	// Indicates the last time the machine learning model version was updated.
	LastUpdatedTime *time.Time

	// The Amazon Resource Name (ARN) of the parent machine learning model that this
	// version belong to.
	ModelArn *string

	// The Amazon S3 location where Amazon Lookout for Equipment saves the pointwise
	// model diagnostics for the model version.
	ModelDiagnosticsOutputConfiguration *types.ModelDiagnosticsOutputConfiguration

	// The Amazon S3 output prefix for where Lookout for Equipment saves the pointwise
	// model diagnostics for the model version.
	ModelDiagnosticsResultsObject *types.S3Object

	// Shows an aggregated summary, in JSON format, of the model's performance within
	// the evaluation time range. These metrics are created when evaluating the model.
	ModelMetrics *string

	// The name of the machine learning model that this version belongs to.
	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 types.ModelQuality

	// The version of the machine learning model.
	ModelVersion *int64

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

	// Indicates that the asset associated with this sensor has been shut off. As long
	// as this condition is met, Lookout for Equipment will not use data from this
	// asset for training, evaluation, or inference.
	OffCondition *string

	// If the model version was retrained, this field shows a summary of the
	// performance of the prior model on the new training range. You can use the
	// information in this JSON-formatted object to compare the new model version and
	// the prior model version.
	PriorModelMetrics *string

	// Indicates the number of days of data used in the most recent scheduled
	// retraining run.
	RetrainingAvailableDataInDays *int32

	// The Amazon Resource Name (ARN) of the role that was used to train the model
	// version.
	RoleArn *string

	// The schema of the data used to train the model version.
	Schema *string

	// The identifier of the KMS key key used to encrypt model version data by Amazon
	// Lookout for Equipment.
	ServerSideKmsKeyId *string

	// If model version was imported, then this field is the arn of the source model
	// version.
	SourceModelVersionArn *string

	// Indicates whether this model version was created by training or by importing.
	SourceType types.ModelVersionSourceType

	// The current status of the model version.
	Status types.ModelVersionStatus

	// The date on which the training data finished being gathered. If you imported
	// the version, this is the date that the training data in the source version
	// finished being gathered.
	TrainingDataEndTime *time.Time

	// The date on which the training data began being gathered. If you imported the
	// version, this is the date that the training data in the source version began
	// being gathered.
	TrainingDataStartTime *time.Time

	// The time when the training of the version completed.
	TrainingExecutionEndTime *time.Time

	// The time when the training of the version began.
	TrainingExecutionStartTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeResourcePolicyInput added in v1.18.0 

type DescribeResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the resource that is associated with the
	// resource policy.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type DescribeResourcePolicyOutput added in v1.18.0 

type DescribeResourcePolicyOutput struct {

	// The time when the resource policy was created.
	CreationTime *time.Time

	// The time when the resource policy was last modified.
	LastModifiedTime *time.Time

	// A unique identifier for a revision of the resource policy.
	PolicyRevisionId *string

	// The resource policy in a JSON-formatted string.
	ResourcePolicy *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRetrainingSchedulerInput added in v1.19.0 

type DescribeRetrainingSchedulerInput struct {

	// The name of the model that the retraining scheduler is attached to.
	//
	// This member is required.
	ModelName *string
	// contains filtered or unexported fields
}

type DescribeRetrainingSchedulerOutput added in v1.19.0 

type DescribeRetrainingSchedulerOutput struct {

	// Indicates the time and date at which the retraining scheduler was created.
	CreatedAt *time.Time

	// 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

	// Indicates how the service uses new models. In MANAGED mode, new models are used
	// for inference if they have better performance than the current model. In MANUAL
	// mode, the new models are not used until they are [manually activated].
	//
	// [manually activated]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation
	PromoteMode types.ModelPromoteMode

	// 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 types.RetrainingSchedulerStatus

	// Indicates the time and date at which the retraining scheduler was updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.18.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.18.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.18.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.18.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.18.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ImportDatasetInput added in v1.18.0 

type ImportDatasetInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Lookout for Equipment generates one.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the dataset to import.
	//
	// This member is required.
	SourceDatasetArn *string

	// The name of the machine learning dataset to be created. If the dataset already
	// exists, Amazon Lookout for Equipment overwrites the existing dataset. If you
	// don't specify this field, it is filled with the name of the source dataset.
	DatasetName *string

	// Provides the identifier of the KMS key key used to encrypt model data by Amazon
	// Lookout for Equipment.
	ServerSideKmsKeyId *string

	// Any tags associated with the dataset to be created.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type ImportDatasetOutput added in v1.18.0 

type ImportDatasetOutput struct {

	// The Amazon Resource Name (ARN) of the dataset that was imported.
	DatasetArn *string

	// The name of the created machine learning dataset.
	DatasetName *string

	// A unique identifier for the job of importing the dataset.
	JobId *string

	// The status of the ImportDataset operation.
	Status types.DatasetStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ImportModelVersionInput added in v1.18.0 

type ImportModelVersionInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Lookout for Equipment generates one.
	//
	// This member is required.
	ClientToken *string

	// The name of the dataset for the machine learning model being imported.
	//
	// This member is required.
	DatasetName *string

	// The Amazon Resource Name (ARN) of the model version to import.
	//
	// This member is required.
	SourceModelVersionArn *string

	// Indicates how to import the accumulated inference data when a model version is
	// imported. The possible values are as follows:
	//
	//   - NO_IMPORT – Don't import the data.
	//
	//   - ADD_WHEN_EMPTY – Only import the data from the source model if there is no
	//   existing data in the target model.
	//
	//   - OVERWRITE – Import the data from the source model and overwrite the
	//   existing data in the target model.
	InferenceDataImportStrategy types.InferenceDataImportStrategy

	// Contains the configuration information for the S3 location being used to hold
	// label data.
	LabelsInputConfiguration *types.LabelsInputConfiguration

	// The name for the machine learning model to be created. If the model already
	// exists, Amazon Lookout for Equipment creates a new version. If you do not
	// specify this field, it is filled with the name of the source model.
	ModelName *string

	// The Amazon Resource Name (ARN) of a role with permission to access the data
	// source being used to create the machine learning model.
	RoleArn *string

	// Provides the identifier of the KMS key key used to encrypt model data by Amazon
	// Lookout for Equipment.
	ServerSideKmsKeyId *string

	// The tags associated with the machine learning model to be created.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type ImportModelVersionOutput added in v1.18.0 

type ImportModelVersionOutput struct {

	// The Amazon Resource Name (ARN) of the model being created.
	ModelArn *string

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

	// The version of the model being created.
	ModelVersion *int64

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

	// The status of the ImportModelVersion operation.
	Status types.ModelVersionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDataIngestionJobsAPIClient 

type ListDataIngestionJobsAPIClient interface {
	ListDataIngestionJobs(context.Context, *ListDataIngestionJobsInput, ...func(*Options)) (*ListDataIngestionJobsOutput, error)
}

ListDataIngestionJobsAPIClient is a client that implements the ListDataIngestionJobs operation.

type ListDataIngestionJobsInput 

type ListDataIngestionJobsInput struct {

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

	//  Specifies the maximum number of data ingestion jobs to list.
	MaxResults *int32

	// An opaque pagination token indicating where to continue the listing of data
	// ingestion jobs.
	NextToken *string

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

type ListDataIngestionJobsOutput 

type ListDataIngestionJobsOutput struct {

	// Specifies information about the specific data ingestion job, including dataset
	// name and status.
	DataIngestionJobSummaries []types.DataIngestionJobSummary

	//  An opaque pagination token indicating where to continue the listing of data
	// ingestion jobs.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDataIngestionJobsPaginator 

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

ListDataIngestionJobsPaginator is a paginator for ListDataIngestionJobs

func NewListDataIngestionJobsPaginator 

func NewListDataIngestionJobsPaginator(client ListDataIngestionJobsAPIClient, params *ListDataIngestionJobsInput, optFns ...func(*ListDataIngestionJobsPaginatorOptions)) *ListDataIngestionJobsPaginator

NewListDataIngestionJobsPaginator returns a new ListDataIngestionJobsPaginator

func (*ListDataIngestionJobsPaginator) HasMorePages 

func (p *ListDataIngestionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataIngestionJobsPaginator) NextPage 

func (p *ListDataIngestionJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataIngestionJobsOutput, error)

NextPage retrieves the next ListDataIngestionJobs page.

type ListDataIngestionJobsPaginatorOptions 

type ListDataIngestionJobsPaginatorOptions struct {
	//  Specifies the maximum number of data ingestion jobs to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDataIngestionJobsPaginatorOptions is the paginator options for ListDataIngestionJobs

type ListDatasetsAPIClient 

type ListDatasetsAPIClient interface {
	ListDatasets(context.Context, *ListDatasetsInput, ...func(*Options)) (*ListDatasetsOutput, error)
}

ListDatasetsAPIClient is a client that implements the ListDatasets operation.

type ListDatasetsInput 

type ListDatasetsInput struct {

	// The beginning of the name of the datasets to be listed.
	DatasetNameBeginsWith *string

	//  Specifies the maximum number of datasets to list.
	MaxResults *int32

	//  An opaque pagination token indicating where to continue the listing of
	// datasets.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDatasetsOutput 

type ListDatasetsOutput struct {

	// Provides information about the specified dataset, including creation time,
	// dataset ARN, and status.
	DatasetSummaries []types.DatasetSummary

	//  An opaque pagination token indicating where to continue the listing of
	// datasets.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetsPaginator 

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

ListDatasetsPaginator is a paginator for ListDatasets

func NewListDatasetsPaginator 

func NewListDatasetsPaginator(client ListDatasetsAPIClient, params *ListDatasetsInput, optFns ...func(*ListDatasetsPaginatorOptions)) *ListDatasetsPaginator

NewListDatasetsPaginator returns a new ListDatasetsPaginator

func (*ListDatasetsPaginator) HasMorePages 

func (p *ListDatasetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetsPaginator) NextPage 

func (p *ListDatasetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetsOutput, error)

NextPage retrieves the next ListDatasets page.

type ListDatasetsPaginatorOptions 

type ListDatasetsPaginatorOptions struct {
	//  Specifies the maximum number of datasets to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatasetsPaginatorOptions is the paginator options for ListDatasets

type ListInferenceEventsAPIClient added in v1.14.0 

type ListInferenceEventsAPIClient interface {
	ListInferenceEvents(context.Context, *ListInferenceEventsInput, ...func(*Options)) (*ListInferenceEventsOutput, error)
}

ListInferenceEventsAPIClient is a client that implements the ListInferenceEvents operation.

type ListInferenceEventsInput added in v1.14.0 

type ListInferenceEventsInput struct {

	// The name of the inference scheduler for the inference events listed.
	//
	// This member is required.
	InferenceSchedulerName *string

	// Returns all the inference events with an end start time equal to or greater
	// than less than the end time given.
	//
	// This member is required.
	IntervalEndTime *time.Time

	//  Lookout for Equipment will return all the inference events with an end time
	// equal to or greater than the start time given.
	//
	// This member is required.
	IntervalStartTime *time.Time

	// Specifies the maximum number of inference events to list.
	MaxResults *int32

	// An opaque pagination token indicating where to continue the listing of
	// inference events.
	NextToken *string
	// contains filtered or unexported fields
}

type ListInferenceEventsOutput added in v1.14.0 

type ListInferenceEventsOutput struct {

	// Provides an array of information about the individual inference events returned
	// from the ListInferenceEvents operation, including scheduler used, event start
	// time, event end time, diagnostics, and so on.
	InferenceEventSummaries []types.InferenceEventSummary

	// An opaque pagination token indicating where to continue the listing of
	// inference executions.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListInferenceEventsPaginator added in v1.14.0 

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

ListInferenceEventsPaginator is a paginator for ListInferenceEvents

func NewListInferenceEventsPaginator added in v1.14.0 

func NewListInferenceEventsPaginator(client ListInferenceEventsAPIClient, params *ListInferenceEventsInput, optFns ...func(*ListInferenceEventsPaginatorOptions)) *ListInferenceEventsPaginator

NewListInferenceEventsPaginator returns a new ListInferenceEventsPaginator

func (*ListInferenceEventsPaginator) HasMorePages added in v1.14.0 

func (p *ListInferenceEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInferenceEventsPaginator) NextPage added in v1.14.0 

func (p *ListInferenceEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInferenceEventsOutput, error)

NextPage retrieves the next ListInferenceEvents page.

type ListInferenceEventsPaginatorOptions added in v1.14.0 

type ListInferenceEventsPaginatorOptions struct {
	// Specifies the maximum number of inference events to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListInferenceEventsPaginatorOptions is the paginator options for ListInferenceEvents

type ListInferenceExecutionsAPIClient 

type ListInferenceExecutionsAPIClient interface {
	ListInferenceExecutions(context.Context, *ListInferenceExecutionsInput, ...func(*Options)) (*ListInferenceExecutionsOutput, error)
}

ListInferenceExecutionsAPIClient is a client that implements the ListInferenceExecutions operation.

type ListInferenceExecutionsInput 

type ListInferenceExecutionsInput struct {

	// The name of the inference scheduler for the inference execution listed.
	//
	// This member is required.
	InferenceSchedulerName *string

	// The time reference in the inferenced dataset before which Amazon Lookout for
	// Equipment stopped the inference execution.
	DataEndTimeBefore *time.Time

	// The time reference in the inferenced dataset after which Amazon Lookout for
	// Equipment started the inference execution.
	DataStartTimeAfter *time.Time

	// Specifies the maximum number of inference executions to list.
	MaxResults *int32

	// An opaque pagination token indicating where to continue the listing of
	// inference executions.
	NextToken *string

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

type ListInferenceExecutionsOutput 

type ListInferenceExecutionsOutput struct {

	// Provides an array of information about the individual inference executions
	// returned from the ListInferenceExecutions operation, including model used,
	// inference scheduler, data configuration, and so on.
	//
	// If you don't supply the InferenceSchedulerName request parameter, or if you
	// supply the name of an inference scheduler that doesn't exist,
	// ListInferenceExecutions returns an empty array in InferenceExecutionSummaries .
	InferenceExecutionSummaries []types.InferenceExecutionSummary

	//  An opaque pagination token indicating where to continue the listing of
	// inference executions.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListInferenceExecutionsPaginator 

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

ListInferenceExecutionsPaginator is a paginator for ListInferenceExecutions

func NewListInferenceExecutionsPaginator 

func NewListInferenceExecutionsPaginator(client ListInferenceExecutionsAPIClient, params *ListInferenceExecutionsInput, optFns ...func(*ListInferenceExecutionsPaginatorOptions)) *ListInferenceExecutionsPaginator

NewListInferenceExecutionsPaginator returns a new ListInferenceExecutionsPaginator

func (*ListInferenceExecutionsPaginator) HasMorePages 

func (p *ListInferenceExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInferenceExecutionsPaginator) NextPage 

func (p *ListInferenceExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInferenceExecutionsOutput, error)

NextPage retrieves the next ListInferenceExecutions page.

type ListInferenceExecutionsPaginatorOptions 

type ListInferenceExecutionsPaginatorOptions struct {
	// Specifies the maximum number of inference executions to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListInferenceExecutionsPaginatorOptions is the paginator options for ListInferenceExecutions

type ListInferenceSchedulersAPIClient 

type ListInferenceSchedulersAPIClient interface {
	ListInferenceSchedulers(context.Context, *ListInferenceSchedulersInput, ...func(*Options)) (*ListInferenceSchedulersOutput, error)
}

ListInferenceSchedulersAPIClient is a client that implements the ListInferenceSchedulers operation.

type ListInferenceSchedulersInput 

type ListInferenceSchedulersInput struct {

	// The beginning of the name of the inference schedulers to be listed.
	InferenceSchedulerNameBeginsWith *string

	//  Specifies the maximum number of inference schedulers to list.
	MaxResults *int32

	// The name of the machine learning model used by the inference scheduler to be
	// listed.
	ModelName *string

	//  An opaque pagination token indicating where to continue the listing of
	// inference schedulers.
	NextToken *string

	// Specifies the current status of the inference schedulers.
	Status types.InferenceSchedulerStatus
	// contains filtered or unexported fields
}

type ListInferenceSchedulersOutput 

type ListInferenceSchedulersOutput struct {

	// Provides information about the specified inference scheduler, including data
	// upload frequency, model name and ARN, and status.
	InferenceSchedulerSummaries []types.InferenceSchedulerSummary

	//  An opaque pagination token indicating where to continue the listing of
	// inference schedulers.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListInferenceSchedulersPaginator 

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

ListInferenceSchedulersPaginator is a paginator for ListInferenceSchedulers

func NewListInferenceSchedulersPaginator 

func NewListInferenceSchedulersPaginator(client ListInferenceSchedulersAPIClient, params *ListInferenceSchedulersInput, optFns ...func(*ListInferenceSchedulersPaginatorOptions)) *ListInferenceSchedulersPaginator

NewListInferenceSchedulersPaginator returns a new ListInferenceSchedulersPaginator

func (*ListInferenceSchedulersPaginator) HasMorePages 

func (p *ListInferenceSchedulersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInferenceSchedulersPaginator) NextPage 

func (p *ListInferenceSchedulersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInferenceSchedulersOutput, error)

NextPage retrieves the next ListInferenceSchedulers page.

type ListInferenceSchedulersPaginatorOptions 

type ListInferenceSchedulersPaginatorOptions struct {
	//  Specifies the maximum number of inference schedulers to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListInferenceSchedulersPaginatorOptions is the paginator options for ListInferenceSchedulers

type ListLabelGroupsAPIClient added in v1.15.0 

type ListLabelGroupsAPIClient interface {
	ListLabelGroups(context.Context, *ListLabelGroupsInput, ...func(*Options)) (*ListLabelGroupsOutput, error)
}

ListLabelGroupsAPIClient is a client that implements the ListLabelGroups operation.

type ListLabelGroupsInput added in v1.15.0 

type ListLabelGroupsInput struct {

	//  The beginning of the name of the label groups to be listed.
	LabelGroupNameBeginsWith *string

	//  Specifies the maximum number of label groups to list.
	MaxResults *int32

	//  An opaque pagination token indicating where to continue the listing of label
	// groups.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLabelGroupsOutput added in v1.15.0 

type ListLabelGroupsOutput struct {

	//  A summary of the label groups.
	LabelGroupSummaries []types.LabelGroupSummary

	//  An opaque pagination token indicating where to continue the listing of label
	// groups.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLabelGroupsPaginator added in v1.15.0 

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

ListLabelGroupsPaginator is a paginator for ListLabelGroups

func NewListLabelGroupsPaginator added in v1.15.0 

func NewListLabelGroupsPaginator(client ListLabelGroupsAPIClient, params *ListLabelGroupsInput, optFns ...func(*ListLabelGroupsPaginatorOptions)) *ListLabelGroupsPaginator

NewListLabelGroupsPaginator returns a new ListLabelGroupsPaginator

func (*ListLabelGroupsPaginator) HasMorePages added in v1.15.0 

func (p *ListLabelGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLabelGroupsPaginator) NextPage added in v1.15.0 

func (p *ListLabelGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLabelGroupsOutput, error)

NextPage retrieves the next ListLabelGroups page.

type ListLabelGroupsPaginatorOptions added in v1.15.0 

type ListLabelGroupsPaginatorOptions struct {
	//  Specifies the maximum number of label groups to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLabelGroupsPaginatorOptions is the paginator options for ListLabelGroups

type ListLabelsAPIClient added in v1.15.0 

type ListLabelsAPIClient interface {
	ListLabels(context.Context, *ListLabelsInput, ...func(*Options)) (*ListLabelsOutput, error)
}

ListLabelsAPIClient is a client that implements the ListLabels operation.

type ListLabelsInput added in v1.15.0 

type ListLabelsInput struct {

	//  Returns the name of the label group.
	//
	// This member is required.
	LabelGroupName *string

	//  Lists the labels that pertain to a particular piece of equipment.
	Equipment *string

	//  Returns labels with a particular fault code.
	FaultCode *string

	//  Returns all labels with a start time earlier than the end time given.
	IntervalEndTime *time.Time

	//  Returns all the labels with a end time equal to or later than the start time
	// given.
	IntervalStartTime *time.Time

	//  Specifies the maximum number of labels to list.
	MaxResults *int32

	//  An opaque pagination token indicating where to continue the listing of label
	// groups.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLabelsOutput added in v1.15.0 

type ListLabelsOutput struct {

	//  A summary of the items in the label group.
	//
	// If you don't supply the LabelGroupName request parameter, or if you supply the
	// name of a label group that doesn't exist, ListLabels returns an empty array in
	// LabelSummaries .
	LabelSummaries []types.LabelSummary

	//  An opaque pagination token indicating where to continue the listing of
	// datasets.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLabelsPaginator added in v1.15.0 

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

ListLabelsPaginator is a paginator for ListLabels

func NewListLabelsPaginator added in v1.15.0 

func NewListLabelsPaginator(client ListLabelsAPIClient, params *ListLabelsInput, optFns ...func(*ListLabelsPaginatorOptions)) *ListLabelsPaginator

NewListLabelsPaginator returns a new ListLabelsPaginator

func (*ListLabelsPaginator) HasMorePages added in v1.15.0 

func (p *ListLabelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLabelsPaginator) NextPage added in v1.15.0 

func (p *ListLabelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLabelsOutput, error)

NextPage retrieves the next ListLabels page.

type ListLabelsPaginatorOptions added in v1.15.0 

type ListLabelsPaginatorOptions struct {
	//  Specifies the maximum number of labels to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLabelsPaginatorOptions is the paginator options for ListLabels

type ListModelVersionsAPIClient added in v1.18.0 

type ListModelVersionsAPIClient interface {
	ListModelVersions(context.Context, *ListModelVersionsInput, ...func(*Options)) (*ListModelVersionsOutput, error)
}

ListModelVersionsAPIClient is a client that implements the ListModelVersions operation.

type ListModelVersionsInput added in v1.18.0 

type ListModelVersionsInput struct {

	// Then name of the machine learning model for which the model versions are to be
	// listed.
	//
	// This member is required.
	ModelName *string

	// Filter results to return all the model versions created before this time.
	CreatedAtEndTime *time.Time

	// Filter results to return all the model versions created after this time.
	CreatedAtStartTime *time.Time

	// Specifies the highest version of the model to return in the list.
	MaxModelVersion *int64

	// Specifies the maximum number of machine learning model versions to list.
	MaxResults *int32

	// Specifies the lowest version of the model to return in the list.
	MinModelVersion *int64

	// If the total number of results exceeds the limit that the response can display,
	// the response returns an opaque pagination token indicating where to continue the
	// listing of machine learning model versions. Use this token in the NextToken
	// field in the request to list the next page of results.
	NextToken *string

	// Filter the results based on the way the model version was generated.
	SourceType types.ModelVersionSourceType

	// Filter the results based on the current status of the model version.
	Status types.ModelVersionStatus
	// contains filtered or unexported fields
}

type ListModelVersionsOutput added in v1.18.0 

type ListModelVersionsOutput struct {

	// Provides information on the specified model version, including the created
	// time, model and dataset ARNs, and status.
	//
	// If you don't supply the ModelName request parameter, or if you supply the name
	// of a model that doesn't exist, ListModelVersions returns an empty array in
	// ModelVersionSummaries .
	ModelVersionSummaries []types.ModelVersionSummary

	// If the total number of results exceeds the limit that the response can display,
	// the response returns an opaque pagination token indicating where to continue the
	// listing of machine learning model versions. Use this token in the NextToken
	// field in the request to list the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListModelVersionsPaginator added in v1.18.0 

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

ListModelVersionsPaginator is a paginator for ListModelVersions

func NewListModelVersionsPaginator added in v1.18.0 

func NewListModelVersionsPaginator(client ListModelVersionsAPIClient, params *ListModelVersionsInput, optFns ...func(*ListModelVersionsPaginatorOptions)) *ListModelVersionsPaginator

NewListModelVersionsPaginator returns a new ListModelVersionsPaginator

func (*ListModelVersionsPaginator) HasMorePages added in v1.18.0 

func (p *ListModelVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelVersionsPaginator) NextPage added in v1.18.0 

func (p *ListModelVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelVersionsOutput, error)

NextPage retrieves the next ListModelVersions page.

type ListModelVersionsPaginatorOptions added in v1.18.0 

type ListModelVersionsPaginatorOptions struct {
	// Specifies the maximum number of machine learning model versions to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListModelVersionsPaginatorOptions is the paginator options for ListModelVersions

type ListModelsAPIClient 

type ListModelsAPIClient interface {
	ListModels(context.Context, *ListModelsInput, ...func(*Options)) (*ListModelsOutput, error)
}

ListModelsAPIClient is a client that implements the ListModels operation.

type ListModelsInput 

type ListModelsInput struct {

	// The beginning of the name of the dataset of the machine learning models to be
	// listed.
	DatasetNameBeginsWith *string

	//  Specifies the maximum number of machine learning models to list.
	MaxResults *int32

	// The beginning of the name of the machine learning models being listed.
	ModelNameBeginsWith *string

	//  An opaque pagination token indicating where to continue the listing of machine
	// learning models.
	NextToken *string

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

type ListModelsOutput 

type ListModelsOutput struct {

	// Provides information on the specified model, including created time, model and
	// dataset ARNs, and status.
	ModelSummaries []types.ModelSummary

	//  An opaque pagination token indicating where to continue the listing of machine
	// learning models.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListModelsPaginator 

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

ListModelsPaginator is a paginator for ListModels

func NewListModelsPaginator 

func NewListModelsPaginator(client ListModelsAPIClient, params *ListModelsInput, optFns ...func(*ListModelsPaginatorOptions)) *ListModelsPaginator

NewListModelsPaginator returns a new ListModelsPaginator

func (*ListModelsPaginator) HasMorePages 

func (p *ListModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelsPaginator) NextPage 

func (p *ListModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelsOutput, error)

NextPage retrieves the next ListModels page.

type ListModelsPaginatorOptions 

type ListModelsPaginatorOptions struct {
	//  Specifies the maximum number of machine learning models to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListModelsPaginatorOptions is the paginator options for ListModels

type ListRetrainingSchedulersAPIClient added in v1.19.0 

type ListRetrainingSchedulersAPIClient interface {
	ListRetrainingSchedulers(context.Context, *ListRetrainingSchedulersInput, ...func(*Options)) (*ListRetrainingSchedulersOutput, error)
}

ListRetrainingSchedulersAPIClient is a client that implements the ListRetrainingSchedulers operation.

type ListRetrainingSchedulersInput added in v1.19.0 

type ListRetrainingSchedulersInput struct {

	// Specifies the maximum number of retraining schedulers to list.
	MaxResults *int32

	// Specify this field to only list retraining schedulers whose machine learning
	// models begin with the value you specify.
	ModelNameBeginsWith *string

	// If the number of results exceeds the maximum, a pagination token is returned.
	// Use the token in the request to show the next page of retraining schedulers.
	NextToken *string

	// Specify this field to only list retraining schedulers whose status matches the
	// value you specify.
	Status types.RetrainingSchedulerStatus
	// contains filtered or unexported fields
}

type ListRetrainingSchedulersOutput added in v1.19.0 

type ListRetrainingSchedulersOutput struct {

	// If the number of results exceeds the maximum, this pagination token is
	// returned. Use this token in the request to show the next page of retraining
	// schedulers.
	NextToken *string

	// Provides information on the specified retraining scheduler, including the model
	// name, model ARN, status, and start date.
	RetrainingSchedulerSummaries []types.RetrainingSchedulerSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRetrainingSchedulersPaginator added in v1.19.0 

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

ListRetrainingSchedulersPaginator is a paginator for ListRetrainingSchedulers

func NewListRetrainingSchedulersPaginator added in v1.19.0 

func NewListRetrainingSchedulersPaginator(client ListRetrainingSchedulersAPIClient, params *ListRetrainingSchedulersInput, optFns ...func(*ListRetrainingSchedulersPaginatorOptions)) *ListRetrainingSchedulersPaginator

NewListRetrainingSchedulersPaginator returns a new ListRetrainingSchedulersPaginator

func (*ListRetrainingSchedulersPaginator) HasMorePages added in v1.19.0 

func (p *ListRetrainingSchedulersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRetrainingSchedulersPaginator) NextPage added in v1.19.0 

func (p *ListRetrainingSchedulersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRetrainingSchedulersOutput, error)

NextPage retrieves the next ListRetrainingSchedulers page.

type ListRetrainingSchedulersPaginatorOptions added in v1.19.0 

type ListRetrainingSchedulersPaginatorOptions struct {
	// Specifies the maximum number of retraining schedulers to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRetrainingSchedulersPaginatorOptions is the paginator options for ListRetrainingSchedulers

type ListSensorStatisticsAPIClient added in v1.13.0 

type ListSensorStatisticsAPIClient interface {
	ListSensorStatistics(context.Context, *ListSensorStatisticsInput, ...func(*Options)) (*ListSensorStatisticsOutput, error)
}

ListSensorStatisticsAPIClient is a client that implements the ListSensorStatistics operation.

type ListSensorStatisticsInput added in v1.13.0 

type ListSensorStatisticsInput struct {

	//  The name of the dataset associated with the list of Sensor Statistics.
	//
	// This member is required.
	DatasetName *string

	//  The ingestion job id associated with the list of Sensor Statistics. To get
	// sensor statistics for a particular ingestion job id, both dataset name and
	// ingestion job id must be submitted as inputs.
	IngestionJobId *string

	// Specifies the maximum number of sensors for which to retrieve statistics.
	MaxResults *int32

	// An opaque pagination token indicating where to continue the listing of sensor
	// statistics.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSensorStatisticsOutput added in v1.13.0 

type ListSensorStatisticsOutput struct {

	// An opaque pagination token indicating where to continue the listing of sensor
	// statistics.
	NextToken *string

	// Provides ingestion-based statistics regarding the specified sensor with respect
	// to various validation types, such as whether data exists, the number and
	// percentage of missing values, and the number and percentage of duplicate
	// timestamps.
	SensorStatisticsSummaries []types.SensorStatisticsSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSensorStatisticsPaginator added in v1.13.0 

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

ListSensorStatisticsPaginator is a paginator for ListSensorStatistics

func NewListSensorStatisticsPaginator added in v1.13.0 

func NewListSensorStatisticsPaginator(client ListSensorStatisticsAPIClient, params *ListSensorStatisticsInput, optFns ...func(*ListSensorStatisticsPaginatorOptions)) *ListSensorStatisticsPaginator

NewListSensorStatisticsPaginator returns a new ListSensorStatisticsPaginator

func (*ListSensorStatisticsPaginator) HasMorePages added in v1.13.0 

func (p *ListSensorStatisticsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSensorStatisticsPaginator) NextPage added in v1.13.0 

func (p *ListSensorStatisticsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSensorStatisticsOutput, error)

NextPage retrieves the next ListSensorStatistics page.

type ListSensorStatisticsPaginatorOptions added in v1.13.0 

type ListSensorStatisticsPaginatorOptions struct {
	// Specifies the maximum number of sensors for which to retrieve statistics.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSensorStatisticsPaginatorOptions is the paginator options for ListSensorStatistics

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource (such as the dataset or model)
	// that is the focus of the ListTagsForResource operation.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	//  Any tags associated with the resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.21.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutResourcePolicyInput added in v1.18.0 

type PutResourcePolicyInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Lookout for Equipment generates one.
	//
	// This member is required.
	ClientToken *string

	// The Amazon Resource Name (ARN) of the resource for which the policy is being
	// created.
	//
	// This member is required.
	ResourceArn *string

	// The JSON-formatted resource policy to create.
	//
	// This member is required.
	ResourcePolicy *string

	// A unique identifier for a revision of the resource policy.
	PolicyRevisionId *string
	// contains filtered or unexported fields
}

type PutResourcePolicyOutput added in v1.18.0 

type PutResourcePolicyOutput struct {

	// A unique identifier for a revision of the resource policy.
	PolicyRevisionId *string

	// The Amazon Resource Name (ARN) of the resource for which the policy was created.
	ResourceArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartDataIngestionJobInput 

type StartDataIngestionJobInput struct {

	//  A unique identifier for the request. If you do not set the client request
	// token, Amazon Lookout for Equipment generates one.
	//
	// This member is required.
	ClientToken *string

	// The name of the dataset being used by the data ingestion job.
	//
	// This member is required.
	DatasetName *string

	//  Specifies information for the input data for the data ingestion job, including
	// dataset S3 location.
	//
	// This member is required.
	IngestionInputConfiguration *types.IngestionInputConfiguration

	//  The Amazon Resource Name (ARN) of a role with permission to access the data
	// source for the data ingestion job.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

type StartDataIngestionJobOutput 

type StartDataIngestionJobOutput struct {

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

	// Indicates the status of the StartDataIngestionJob operation.
	Status types.IngestionJobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartInferenceSchedulerInput 

type StartInferenceSchedulerInput struct {

	// The name of the inference scheduler to be started.
	//
	// This member is required.
	InferenceSchedulerName *string
	// contains filtered or unexported fields
}

type StartInferenceSchedulerOutput 

type StartInferenceSchedulerOutput struct {

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

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

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

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

	// Indicates the status of the inference scheduler.
	Status types.InferenceSchedulerStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartRetrainingSchedulerInput added in v1.19.0 

type StartRetrainingSchedulerInput struct {

	// The name of the model whose retraining scheduler you want to start.
	//
	// This member is required.
	ModelName *string
	// contains filtered or unexported fields
}

type StartRetrainingSchedulerOutput added in v1.19.0 

type StartRetrainingSchedulerOutput struct {

	// The ARN of the model whose retraining scheduler is being started.
	ModelArn *string

	// The name of the model whose retraining scheduler is being started.
	ModelName *string

	// The status of the retraining scheduler.
	Status types.RetrainingSchedulerStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopInferenceSchedulerInput 

type StopInferenceSchedulerInput struct {

	// The name of the inference scheduler to be stopped.
	//
	// This member is required.
	InferenceSchedulerName *string
	// contains filtered or unexported fields
}

type StopInferenceSchedulerOutput 

type StopInferenceSchedulerOutput struct {

	// The Amazon Resource Name (ARN) of the inference schedule being stopped.
	InferenceSchedulerArn *string

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

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

	// The name of the machine learning model used by the inference scheduler being
	// stopped.
	ModelName *string

	// Indicates the status of the inference scheduler.
	Status types.InferenceSchedulerStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopRetrainingSchedulerInput added in v1.19.0 

type StopRetrainingSchedulerInput struct {

	// The name of the model whose retraining scheduler you want to stop.
	//
	// This member is required.
	ModelName *string
	// contains filtered or unexported fields
}

type StopRetrainingSchedulerOutput added in v1.19.0 

type StopRetrainingSchedulerOutput struct {

	// The ARN of the model whose retraining scheduler is being stopped.
	ModelArn *string

	// The name of the model whose retraining scheduler is being stopped.
	ModelName *string

	// The status of the retraining scheduler.
	Status types.RetrainingSchedulerStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the specific resource to which the tag should
	// be associated.
	//
	// This member is required.
	ResourceArn *string

	// The tag or tags to be associated with a specific resource. Both the tag key and
	// value are specified.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to which the tag is currently
	// associated.
	//
	// This member is required.
	ResourceArn *string

	// Specifies the key of the tag to be removed from a specified resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateActiveModelVersionInput added in v1.18.0 

type UpdateActiveModelVersionInput struct {

	// The name of the machine learning model for which the active model version is
	// being set.
	//
	// This member is required.
	ModelName *string

	// The version of the machine learning model for which the active model version is
	// being set.
	//
	// This member is required.
	ModelVersion *int64
	// contains filtered or unexported fields
}

type UpdateActiveModelVersionOutput added in v1.18.0 

type UpdateActiveModelVersionOutput struct {

	// The version that is currently active of the machine learning model for which
	// the active model version was set.
	CurrentActiveVersion *int64

	// The Amazon Resource Name (ARN) of the machine learning model version that is
	// the current active model version.
	CurrentActiveVersionArn *string

	// The Amazon Resource Name (ARN) of the machine learning model for which the
	// active model version was set.
	ModelArn *string

	// The name of the machine learning model for which the active model version was
	// set.
	ModelName *string

	// The previous version that was active of the machine learning model for which
	// the active model version was set.
	PreviousActiveVersion *int64

	// The Amazon Resource Name (ARN) of the machine learning model version that was
	// the previous active model version.
	PreviousActiveVersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateInferenceSchedulerInput 

type UpdateInferenceSchedulerInput struct {

	// The name of the inference scheduler to be updated.
	//
	// This member is required.
	InferenceSchedulerName *string

	//  A period of time (in minutes) by which inference on the data is delayed after
	// the data starts. For instance, if you select an offset delay time of five
	// minutes, 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

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

	//  Specifies information for the output results from the inference scheduler,
	// including the output S3 location.
	DataOutputConfiguration *types.InferenceOutputConfiguration

	// How often data is uploaded to the source S3 bucket for the input data. The
	// value chosen 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 types.DataUploadFrequency

	//  The Amazon Resource Name (ARN) of a role with permission to access the data
	// source for the inference scheduler.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateInferenceSchedulerOutput 

type UpdateInferenceSchedulerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateLabelGroupInput added in v1.15.0 

type UpdateLabelGroupInput struct {

	//  The name of the label group to be updated.
	//
	// This member is required.
	LabelGroupName *string

	//  Updates the code indicating 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.
	FaultCodes []string
	// contains filtered or unexported fields
}

type UpdateLabelGroupOutput added in v1.15.0 

type UpdateLabelGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateModelInput added in v1.19.0 

type UpdateModelInput struct {

	// The name of the model to update.
	//
	// This member is required.
	ModelName *string

	// Contains the configuration information for the S3 location being used to hold
	// label data.
	LabelsInputConfiguration *types.LabelsInputConfiguration

	// The Amazon S3 location where you want Amazon Lookout for Equipment to save the
	// pointwise model diagnostics for the model. You must also specify the RoleArn
	// request parameter.
	ModelDiagnosticsOutputConfiguration *types.ModelDiagnosticsOutputConfiguration

	// The ARN of the model to update.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateModelOutput added in v1.19.0 

type UpdateModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRetrainingSchedulerInput added in v1.19.0 

type UpdateRetrainingSchedulerInput struct {

	// The name of the model whose retraining scheduler you want to update.
	//
	// This member is required.
	ModelName *string

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

	// Indicates how the service will use new models. In MANAGED mode, new models will
	// automatically be used for inference if they have better performance than the
	// current model. In MANUAL mode, the new models will not be used [until they are manually activated].
	//
	// [until they are manually activated]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation
	PromoteMode types.ModelPromoteMode

	// This parameter uses the [ISO 8601] standard to set the frequency at which you want
	// retraining to occur in terms of Years, Months, and/or Days (note: other
	// parameters like Time are not currently supported). The minimum value is 30 days
	// (P30D) and the maximum value is 1 year (P1Y). For example, the following values
	// are valid:
	//
	//   - P3M15D – Every 3 months and 15 days
	//
	//   - P2M – Every 2 months
	//
	//   - P150D – Every 150 days
	//
	// [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
	// contains filtered or unexported fields
}

type UpdateRetrainingSchedulerOutput added in v1.19.0 

type UpdateRetrainingSchedulerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.