Class: Aws::LookoutEquipment::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::LookoutEquipment::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb
Overview
An API client for LookoutEquipment. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::LookoutEquipment::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a container for a collection of data being ingested for analysis.
-
#create_inference_scheduler(params = {}) ⇒ Types::CreateInferenceSchedulerResponse
Creates a scheduled inference.
-
#create_label(params = {}) ⇒ Types::CreateLabelResponse
Creates a label for an event.
-
#create_label_group(params = {}) ⇒ Types::CreateLabelGroupResponse
Creates a group of labels.
-
#create_model(params = {}) ⇒ Types::CreateModelResponse
Creates an ML model for data inference.
-
#delete_dataset(params = {}) ⇒ Struct
Deletes a dataset and associated artifacts.
-
#delete_inference_scheduler(params = {}) ⇒ Struct
Deletes an inference scheduler that has been set up.
-
#delete_label(params = {}) ⇒ Struct
Deletes a label.
-
#delete_label_group(params = {}) ⇒ Struct
Deletes a group of labels.
-
#delete_model(params = {}) ⇒ Struct
Deletes an ML model currently available for Amazon Lookout for Equipment.
-
#describe_data_ingestion_job(params = {}) ⇒ Types::DescribeDataIngestionJobResponse
Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.
-
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Provides a JSON description of the data in each time series dataset, including names, column names, and data types.
-
#describe_inference_scheduler(params = {}) ⇒ Types::DescribeInferenceSchedulerResponse
Specifies information about the inference scheduler being used, including name, model, status, and associated metadata.
-
#describe_label(params = {}) ⇒ Types::DescribeLabelResponse
Returns the name of the label.
-
#describe_label_group(params = {}) ⇒ Types::DescribeLabelGroupResponse
Returns information about the label group.
-
#describe_model(params = {}) ⇒ Types::DescribeModelResponse
Provides a JSON containing the overall information about a specific ML model, including model name and ARN, dataset, training and evaluation information, status, and so on.
-
#list_data_ingestion_jobs(params = {}) ⇒ Types::ListDataIngestionJobsResponse
Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.
-
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Lists all datasets currently available in your account, filtering on the dataset name.
-
#list_inference_events(params = {}) ⇒ Types::ListInferenceEventsResponse
Lists all inference events that have been found for the specified inference scheduler.
-
#list_inference_executions(params = {}) ⇒ Types::ListInferenceExecutionsResponse
Lists all inference executions that have been performed by the specified inference scheduler.
-
#list_inference_schedulers(params = {}) ⇒ Types::ListInferenceSchedulersResponse
Retrieves a list of all inference schedulers currently available for your account.
-
#list_label_groups(params = {}) ⇒ Types::ListLabelGroupsResponse
Returns a list of the label groups.
-
#list_labels(params = {}) ⇒ Types::ListLabelsResponse
Provides a list of labels.
-
#list_models(params = {}) ⇒ Types::ListModelsResponse
Generates a list of all models in the account, including model name and ARN, dataset, and status.
-
#list_sensor_statistics(params = {}) ⇒ Types::ListSensorStatisticsResponse
Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all the tags for a specified resource, including key and value.
-
#start_data_ingestion_job(params = {}) ⇒ Types::StartDataIngestionJobResponse
Starts a data ingestion job.
-
#start_inference_scheduler(params = {}) ⇒ Types::StartInferenceSchedulerResponse
Starts an inference scheduler.
-
#stop_inference_scheduler(params = {}) ⇒ Types::StopInferenceSchedulerResponse
Stops an inference scheduler.
-
#tag_resource(params = {}) ⇒ Struct
Associates a given tag to a resource in your account.
-
#untag_resource(params = {}) ⇒ Struct
Removes a specific tag from a given resource.
-
#update_inference_scheduler(params = {}) ⇒ Struct
Updates an inference scheduler.
-
#update_label_group(params = {}) ⇒ Struct
Updates the label group.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
375 376 377 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 375 def initialize(*args) super end |
Instance Method Details
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
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. In other words, 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.
442 443 444 445 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 442 def create_dataset(params = {}, = {}) req = build_request(:create_dataset, params) req.send_request() end |
#create_inference_scheduler(params = {}) ⇒ Types::CreateInferenceSchedulerResponse
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.
572 573 574 575 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 572 def create_inference_scheduler(params = {}, = {}) req = build_request(:create_inference_scheduler, params) req.send_request() end |
#create_label(params = {}) ⇒ Types::CreateLabelResponse
Creates a label for an event.
645 646 647 648 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 645 def create_label(params = {}, = {}) req = build_request(:create_label, params) req.send_request() end |
#create_label_group(params = {}) ⇒ Types::CreateLabelGroupResponse
Creates a group of labels.
706 707 708 709 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 706 def create_label_group(params = {}, = {}) req = build_request(:create_label_group, params) req.send_request() end |
#create_model(params = {}) ⇒ Types::CreateModelResponse
Creates an ML 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.
837 838 839 840 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 837 def create_model(params = {}, = {}) req = build_request(:create_model, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Struct
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.
864 865 866 867 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 864 def delete_dataset(params = {}, = {}) req = build_request(:delete_dataset, params) req.send_request() end |
#delete_inference_scheduler(params = {}) ⇒ Struct
Deletes an inference scheduler that has been set up. Already processed output results are not affected.
887 888 889 890 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 887 def delete_inference_scheduler(params = {}, = {}) req = build_request(:delete_inference_scheduler, params) req.send_request() end |
#delete_label(params = {}) ⇒ Struct
Deletes a label.
915 916 917 918 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 915 def delete_label(params = {}, = {}) req = build_request(:delete_label, params) req.send_request() end |
#delete_label_group(params = {}) ⇒ Struct
Deletes a group of labels.
939 940 941 942 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 939 def delete_label_group(params = {}, = {}) req = build_request(:delete_label_group, params) req.send_request() end |
#delete_model(params = {}) ⇒ Struct
Deletes an ML 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.
963 964 965 966 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 963 def delete_model(params = {}, = {}) req = build_request(:delete_model, params) req.send_request() end |
#describe_data_ingestion_job(params = {}) ⇒ Types::DescribeDataIngestionJobResponse
Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.
1029 1030 1031 1032 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1029 def describe_data_ingestion_job(params = {}, = {}) req = build_request(:describe_data_ingestion_job, params) req.send_request() end |
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Provides a JSON description of the data in each time series dataset, including names, column names, and data types.
1095 1096 1097 1098 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1095 def describe_dataset(params = {}, = {}) req = build_request(:describe_dataset, params) req.send_request() end |
#describe_inference_scheduler(params = {}) ⇒ Types::DescribeInferenceSchedulerResponse
Specifies information about the inference scheduler being used, including name, model, status, and associated metadata
1156 1157 1158 1159 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1156 def describe_inference_scheduler(params = {}, = {}) req = build_request(:describe_inference_scheduler, params) req.send_request() end |
#describe_label(params = {}) ⇒ Types::DescribeLabelResponse
Returns the name of the label.
1206 1207 1208 1209 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1206 def describe_label(params = {}, = {}) req = build_request(:describe_label, params) req.send_request() end |
#describe_label_group(params = {}) ⇒ Types::DescribeLabelGroupResponse
Returns information about the label group.
1243 1244 1245 1246 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1243 def describe_label_group(params = {}, = {}) req = build_request(:describe_label_group, params) req.send_request() end |
#describe_model(params = {}) ⇒ Types::DescribeModelResponse
Provides a JSON containing the overall information about a specific ML model, including model name and ARN, dataset, training and evaluation information, status, and so on.
1315 1316 1317 1318 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1315 def describe_model(params = {}, = {}) req = build_request(:describe_model, params) req.send_request() end |
#list_data_ingestion_jobs(params = {}) ⇒ Types::ListDataIngestionJobsResponse
Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1368 1369 1370 1371 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1368 def list_data_ingestion_jobs(params = {}, = {}) req = build_request(:list_data_ingestion_jobs, params) req.send_request() end |
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse
Lists all datasets currently available in your account, filtering on the dataset name.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1414 1415 1416 1417 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1414 def list_datasets(params = {}, = {}) req = build_request(:list_datasets, params) req.send_request() end |
#list_inference_events(params = {}) ⇒ Types::ListInferenceEventsResponse
Lists all inference events that have been found for the specified inference scheduler.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1472 1473 1474 1475 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1472 def list_inference_events(params = {}, = {}) req = build_request(:list_inference_events, params) req.send_request() end |
#list_inference_executions(params = {}) ⇒ Types::ListInferenceExecutionsResponse
Lists all inference executions that have been performed by the specified inference scheduler.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1548 1549 1550 1551 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1548 def list_inference_executions(params = {}, = {}) req = build_request(:list_inference_executions, params) req.send_request() end |
#list_inference_schedulers(params = {}) ⇒ Types::ListInferenceSchedulersResponse
Retrieves a list of all inference schedulers currently available for your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1606 1607 1608 1609 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1606 def list_inference_schedulers(params = {}, = {}) req = build_request(:list_inference_schedulers, params) req.send_request() end |
#list_label_groups(params = {}) ⇒ Types::ListLabelGroupsResponse
Returns a list of the label groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1651 1652 1653 1654 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1651 def list_label_groups(params = {}, = {}) req = build_request(:list_label_groups, params) req.send_request() end |
#list_labels(params = {}) ⇒ Types::ListLabelsResponse
Provides a list of labels.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1718 1719 1720 1721 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1718 def list_labels(params = {}, = {}) req = build_request(:list_labels, params) req.send_request() end |
#list_models(params = {}) ⇒ Types::ListModelsResponse
Generates a list of all models in the account, including model name and ARN, dataset, and status.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1775 1776 1777 1778 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1775 def list_models(params = {}, = {}) req = build_request(:list_models, params) req.send_request() end |
#list_sensor_statistics(params = {}) ⇒ Types::ListSensorStatisticsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1846 1847 1848 1849 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1846 def list_sensor_statistics(params = {}, = {}) req = build_request(:list_sensor_statistics, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all the tags for a specified resource, including key and value.
1877 1878 1879 1880 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1877 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_data_ingestion_job(params = {}) ⇒ Types::StartDataIngestionJobResponse
Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.
1932 1933 1934 1935 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1932 def start_data_ingestion_job(params = {}, = {}) req = build_request(:start_data_ingestion_job, params) req.send_request() end |
#start_inference_scheduler(params = {}) ⇒ Types::StartInferenceSchedulerResponse
Starts an inference scheduler.
1968 1969 1970 1971 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 1968 def start_inference_scheduler(params = {}, = {}) req = build_request(:start_inference_scheduler, params) req.send_request() end |
#stop_inference_scheduler(params = {}) ⇒ Types::StopInferenceSchedulerResponse
Stops an inference scheduler.
2004 2005 2006 2007 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 2004 def stop_inference_scheduler(params = {}, = {}) req = build_request(:stop_inference_scheduler, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
2042 2043 2044 2045 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 2042 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a specific tag from a given resource. The tag is specified by its key.
2070 2071 2072 2073 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 2070 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_inference_scheduler(params = {}) ⇒ Struct
Updates an inference scheduler.
2145 2146 2147 2148 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 2145 def update_inference_scheduler(params = {}, = {}) req = build_request(:update_inference_scheduler, params) req.send_request() end |
#update_label_group(params = {}) ⇒ Struct
Updates the label group.
2175 2176 2177 2178 |
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/client.rb', line 2175 def update_label_group(params = {}, = {}) req = build_request(:update_label_group, params) req.send_request() end |