LookoutEquipmentClient#
Index > LookoutEquipment > LookoutEquipmentClient
Auto-generated documentation for LookoutEquipment type annotations stubs module mypy-boto3-lookoutequipment.
LookoutEquipmentClient#
Type annotations and code completion for boto3.client("lookoutequipment")
.
boto3 documentation
# LookoutEquipmentClient usage example
from boto3.session import Session
from mypy_boto3_lookoutequipment.client import LookoutEquipmentClient
def get_lookoutequipment_client() -> LookoutEquipmentClient:
return Session().client("lookoutequipment")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("lookoutequipment").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("lookoutequipment")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_lookoutequipment.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("lookoutequipment").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("lookoutequipment").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_dataset#
Creates a container for a collection of data being ingested for analysis.
Type annotations and code completion for boto3.client("lookoutequipment").create_dataset
method.
boto3 documentation
# create_dataset method definition
def create_dataset(
self,
*,
DatasetName: str,
ClientToken: str,
DatasetSchema: DatasetSchemaTypeDef = ..., # (1)
ServerSideKmsKeyId: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateDatasetResponseTypeDef: # (3)
...
# create_dataset method usage example with argument unpacking
kwargs: CreateDatasetRequestRequestTypeDef = { # (1)
"DatasetName": ...,
"ClientToken": ...,
}
parent.create_dataset(**kwargs)
create_inference_scheduler#
Creates a scheduled inference.
Type annotations and code completion for boto3.client("lookoutequipment").create_inference_scheduler
method.
boto3 documentation
# create_inference_scheduler method definition
def create_inference_scheduler(
self,
*,
ModelName: str,
InferenceSchedulerName: str,
DataUploadFrequency: DataUploadFrequencyType, # (1)
DataInputConfiguration: InferenceInputConfigurationTypeDef, # (2)
DataOutputConfiguration: InferenceOutputConfigurationTypeDef, # (3)
RoleArn: str,
ClientToken: str,
DataDelayOffsetInMinutes: int = ...,
ServerSideKmsKeyId: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateInferenceSchedulerResponseTypeDef: # (5)
...
- See DataUploadFrequencyType
- See InferenceInputConfigurationTypeDef
- See InferenceOutputConfigurationTypeDef
- See TagTypeDef
- See CreateInferenceSchedulerResponseTypeDef
# create_inference_scheduler method usage example with argument unpacking
kwargs: CreateInferenceSchedulerRequestRequestTypeDef = { # (1)
"ModelName": ...,
"InferenceSchedulerName": ...,
"DataUploadFrequency": ...,
"DataInputConfiguration": ...,
"DataOutputConfiguration": ...,
"RoleArn": ...,
"ClientToken": ...,
}
parent.create_inference_scheduler(**kwargs)
create_label#
Creates a label for an event.
Type annotations and code completion for boto3.client("lookoutequipment").create_label
method.
boto3 documentation
# create_label method definition
def create_label(
self,
*,
LabelGroupName: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
Rating: LabelRatingType, # (1)
ClientToken: str,
FaultCode: str = ...,
Notes: str = ...,
Equipment: str = ...,
) -> CreateLabelResponseTypeDef: # (2)
...
# create_label method usage example with argument unpacking
kwargs: CreateLabelRequestRequestTypeDef = { # (1)
"LabelGroupName": ...,
"StartTime": ...,
"EndTime": ...,
"Rating": ...,
"ClientToken": ...,
}
parent.create_label(**kwargs)
create_label_group#
Creates a group of labels.
Type annotations and code completion for boto3.client("lookoutequipment").create_label_group
method.
boto3 documentation
# create_label_group method definition
def create_label_group(
self,
*,
LabelGroupName: str,
ClientToken: str,
FaultCodes: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateLabelGroupResponseTypeDef: # (2)
...
# create_label_group method usage example with argument unpacking
kwargs: CreateLabelGroupRequestRequestTypeDef = { # (1)
"LabelGroupName": ...,
"ClientToken": ...,
}
parent.create_label_group(**kwargs)
create_model#
Creates an ML model for data inference.
Type annotations and code completion for boto3.client("lookoutequipment").create_model
method.
boto3 documentation
# create_model method definition
def create_model(
self,
*,
ModelName: str,
DatasetName: str,
ClientToken: str,
DatasetSchema: DatasetSchemaTypeDef = ..., # (1)
LabelsInputConfiguration: LabelsInputConfigurationTypeDef = ..., # (2)
TrainingDataStartTime: Union[datetime, str] = ...,
TrainingDataEndTime: Union[datetime, str] = ...,
EvaluationDataStartTime: Union[datetime, str] = ...,
EvaluationDataEndTime: Union[datetime, str] = ...,
RoleArn: str = ...,
DataPreProcessingConfiguration: DataPreProcessingConfigurationTypeDef = ..., # (3)
ServerSideKmsKeyId: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
OffCondition: str = ...,
) -> CreateModelResponseTypeDef: # (5)
...
- See DatasetSchemaTypeDef
- See LabelsInputConfigurationTypeDef
- See DataPreProcessingConfigurationTypeDef
- See TagTypeDef
- See CreateModelResponseTypeDef
# create_model method usage example with argument unpacking
kwargs: CreateModelRequestRequestTypeDef = { # (1)
"ModelName": ...,
"DatasetName": ...,
"ClientToken": ...,
}
parent.create_model(**kwargs)
delete_dataset#
Deletes a dataset and associated artifacts.
Type annotations and code completion for boto3.client("lookoutequipment").delete_dataset
method.
boto3 documentation
# delete_dataset method definition
def delete_dataset(
self,
*,
DatasetName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_dataset method usage example with argument unpacking
kwargs: DeleteDatasetRequestRequestTypeDef = { # (1)
"DatasetName": ...,
}
parent.delete_dataset(**kwargs)
delete_inference_scheduler#
Deletes an inference scheduler that has been set up.
Type annotations and code completion for boto3.client("lookoutequipment").delete_inference_scheduler
method.
boto3 documentation
# delete_inference_scheduler method definition
def delete_inference_scheduler(
self,
*,
InferenceSchedulerName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_inference_scheduler method usage example with argument unpacking
kwargs: DeleteInferenceSchedulerRequestRequestTypeDef = { # (1)
"InferenceSchedulerName": ...,
}
parent.delete_inference_scheduler(**kwargs)
delete_label#
Deletes a label.
Type annotations and code completion for boto3.client("lookoutequipment").delete_label
method.
boto3 documentation
# delete_label method definition
def delete_label(
self,
*,
LabelGroupName: str,
LabelId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_label method usage example with argument unpacking
kwargs: DeleteLabelRequestRequestTypeDef = { # (1)
"LabelGroupName": ...,
"LabelId": ...,
}
parent.delete_label(**kwargs)
delete_label_group#
Deletes a group of labels.
Type annotations and code completion for boto3.client("lookoutequipment").delete_label_group
method.
boto3 documentation
# delete_label_group method definition
def delete_label_group(
self,
*,
LabelGroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_label_group method usage example with argument unpacking
kwargs: DeleteLabelGroupRequestRequestTypeDef = { # (1)
"LabelGroupName": ...,
}
parent.delete_label_group(**kwargs)
delete_model#
Deletes an ML model currently available for Amazon Lookout for Equipment.
Type annotations and code completion for boto3.client("lookoutequipment").delete_model
method.
boto3 documentation
# delete_model method definition
def delete_model(
self,
*,
ModelName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_model method usage example with argument unpacking
kwargs: DeleteModelRequestRequestTypeDef = { # (1)
"ModelName": ...,
}
parent.delete_model(**kwargs)
describe_data_ingestion_job#
Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.
Type annotations and code completion for boto3.client("lookoutequipment").describe_data_ingestion_job
method.
boto3 documentation
# describe_data_ingestion_job method definition
def describe_data_ingestion_job(
self,
*,
JobId: str,
) -> DescribeDataIngestionJobResponseTypeDef: # (1)
...
# describe_data_ingestion_job method usage example with argument unpacking
kwargs: DescribeDataIngestionJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.describe_data_ingestion_job(**kwargs)
describe_dataset#
Provides a JSON description of the data in each time series dataset, including names, column names, and data types.
Type annotations and code completion for boto3.client("lookoutequipment").describe_dataset
method.
boto3 documentation
# describe_dataset method definition
def describe_dataset(
self,
*,
DatasetName: str,
) -> DescribeDatasetResponseTypeDef: # (1)
...
# describe_dataset method usage example with argument unpacking
kwargs: DescribeDatasetRequestRequestTypeDef = { # (1)
"DatasetName": ...,
}
parent.describe_dataset(**kwargs)
describe_inference_scheduler#
Specifies information about the inference scheduler being used, including name, model, status, and associated metadata See also: AWS API Documentation.
Type annotations and code completion for boto3.client("lookoutequipment").describe_inference_scheduler
method.
boto3 documentation
# describe_inference_scheduler method definition
def describe_inference_scheduler(
self,
*,
InferenceSchedulerName: str,
) -> DescribeInferenceSchedulerResponseTypeDef: # (1)
...
# describe_inference_scheduler method usage example with argument unpacking
kwargs: DescribeInferenceSchedulerRequestRequestTypeDef = { # (1)
"InferenceSchedulerName": ...,
}
parent.describe_inference_scheduler(**kwargs)
describe_label#
Returns the name of the label.
Type annotations and code completion for boto3.client("lookoutequipment").describe_label
method.
boto3 documentation
# describe_label method definition
def describe_label(
self,
*,
LabelGroupName: str,
LabelId: str,
) -> DescribeLabelResponseTypeDef: # (1)
...
# describe_label method usage example with argument unpacking
kwargs: DescribeLabelRequestRequestTypeDef = { # (1)
"LabelGroupName": ...,
"LabelId": ...,
}
parent.describe_label(**kwargs)
describe_label_group#
Returns information about the label group.
Type annotations and code completion for boto3.client("lookoutequipment").describe_label_group
method.
boto3 documentation
# describe_label_group method definition
def describe_label_group(
self,
*,
LabelGroupName: str,
) -> DescribeLabelGroupResponseTypeDef: # (1)
...
# describe_label_group method usage example with argument unpacking
kwargs: DescribeLabelGroupRequestRequestTypeDef = { # (1)
"LabelGroupName": ...,
}
parent.describe_label_group(**kwargs)
describe_model#
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.
Type annotations and code completion for boto3.client("lookoutequipment").describe_model
method.
boto3 documentation
# describe_model method definition
def describe_model(
self,
*,
ModelName: str,
) -> DescribeModelResponseTypeDef: # (1)
...
# describe_model method usage example with argument unpacking
kwargs: DescribeModelRequestRequestTypeDef = { # (1)
"ModelName": ...,
}
parent.describe_model(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("lookoutequipment").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_data_ingestion_jobs#
Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.
Type annotations and code completion for boto3.client("lookoutequipment").list_data_ingestion_jobs
method.
boto3 documentation
# list_data_ingestion_jobs method definition
def list_data_ingestion_jobs(
self,
*,
DatasetName: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
Status: IngestionJobStatusType = ..., # (1)
) -> ListDataIngestionJobsResponseTypeDef: # (2)
...
# list_data_ingestion_jobs method usage example with argument unpacking
kwargs: ListDataIngestionJobsRequestRequestTypeDef = { # (1)
"DatasetName": ...,
}
parent.list_data_ingestion_jobs(**kwargs)
list_datasets#
Lists all datasets currently available in your account, filtering on the dataset name.
Type annotations and code completion for boto3.client("lookoutequipment").list_datasets
method.
boto3 documentation
# list_datasets method definition
def list_datasets(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
DatasetNameBeginsWith: str = ...,
) -> ListDatasetsResponseTypeDef: # (1)
...
# list_datasets method usage example with argument unpacking
kwargs: ListDatasetsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_datasets(**kwargs)
list_inference_events#
Lists all inference events that have been found for the specified inference scheduler.
Type annotations and code completion for boto3.client("lookoutequipment").list_inference_events
method.
boto3 documentation
# list_inference_events method definition
def list_inference_events(
self,
*,
InferenceSchedulerName: str,
IntervalStartTime: Union[datetime, str],
IntervalEndTime: Union[datetime, str],
NextToken: str = ...,
MaxResults: int = ...,
) -> ListInferenceEventsResponseTypeDef: # (1)
...
# list_inference_events method usage example with argument unpacking
kwargs: ListInferenceEventsRequestRequestTypeDef = { # (1)
"InferenceSchedulerName": ...,
"IntervalStartTime": ...,
"IntervalEndTime": ...,
}
parent.list_inference_events(**kwargs)
list_inference_executions#
Lists all inference executions that have been performed by the specified inference scheduler.
Type annotations and code completion for boto3.client("lookoutequipment").list_inference_executions
method.
boto3 documentation
# list_inference_executions method definition
def list_inference_executions(
self,
*,
InferenceSchedulerName: str,
NextToken: str = ...,
MaxResults: int = ...,
DataStartTimeAfter: Union[datetime, str] = ...,
DataEndTimeBefore: Union[datetime, str] = ...,
Status: InferenceExecutionStatusType = ..., # (1)
) -> ListInferenceExecutionsResponseTypeDef: # (2)
...
# list_inference_executions method usage example with argument unpacking
kwargs: ListInferenceExecutionsRequestRequestTypeDef = { # (1)
"InferenceSchedulerName": ...,
}
parent.list_inference_executions(**kwargs)
list_inference_schedulers#
Retrieves a list of all inference schedulers currently available for your account.
Type annotations and code completion for boto3.client("lookoutequipment").list_inference_schedulers
method.
boto3 documentation
# list_inference_schedulers method definition
def list_inference_schedulers(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
InferenceSchedulerNameBeginsWith: str = ...,
ModelName: str = ...,
Status: InferenceSchedulerStatusType = ..., # (1)
) -> ListInferenceSchedulersResponseTypeDef: # (2)
...
# list_inference_schedulers method usage example with argument unpacking
kwargs: ListInferenceSchedulersRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_inference_schedulers(**kwargs)
list_label_groups#
Returns a list of the label groups.
Type annotations and code completion for boto3.client("lookoutequipment").list_label_groups
method.
boto3 documentation
# list_label_groups method definition
def list_label_groups(
self,
*,
LabelGroupNameBeginsWith: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListLabelGroupsResponseTypeDef: # (1)
...
# list_label_groups method usage example with argument unpacking
kwargs: ListLabelGroupsRequestRequestTypeDef = { # (1)
"LabelGroupNameBeginsWith": ...,
}
parent.list_label_groups(**kwargs)
list_labels#
Provides a list of labels.
Type annotations and code completion for boto3.client("lookoutequipment").list_labels
method.
boto3 documentation
# list_labels method definition
def list_labels(
self,
*,
LabelGroupName: str,
IntervalStartTime: Union[datetime, str] = ...,
IntervalEndTime: Union[datetime, str] = ...,
FaultCode: str = ...,
Equipment: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListLabelsResponseTypeDef: # (1)
...
# list_labels method usage example with argument unpacking
kwargs: ListLabelsRequestRequestTypeDef = { # (1)
"LabelGroupName": ...,
}
parent.list_labels(**kwargs)
list_models#
Generates a list of all models in the account, including model name and ARN, dataset, and status.
Type annotations and code completion for boto3.client("lookoutequipment").list_models
method.
boto3 documentation
# list_models method definition
def list_models(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Status: ModelStatusType = ..., # (1)
ModelNameBeginsWith: str = ...,
DatasetNameBeginsWith: str = ...,
) -> ListModelsResponseTypeDef: # (2)
...
# list_models method usage example with argument unpacking
kwargs: ListModelsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_models(**kwargs)
list_sensor_statistics#
Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset.
Type annotations and code completion for boto3.client("lookoutequipment").list_sensor_statistics
method.
boto3 documentation
# list_sensor_statistics method definition
def list_sensor_statistics(
self,
*,
DatasetName: str,
IngestionJobId: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListSensorStatisticsResponseTypeDef: # (1)
...
# list_sensor_statistics method usage example with argument unpacking
kwargs: ListSensorStatisticsRequestRequestTypeDef = { # (1)
"DatasetName": ...,
}
parent.list_sensor_statistics(**kwargs)
list_tags_for_resource#
Lists all the tags for a specified resource, including key and value.
Type annotations and code completion for boto3.client("lookoutequipment").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
start_data_ingestion_job#
Starts a data ingestion job.
Type annotations and code completion for boto3.client("lookoutequipment").start_data_ingestion_job
method.
boto3 documentation
# start_data_ingestion_job method definition
def start_data_ingestion_job(
self,
*,
DatasetName: str,
IngestionInputConfiguration: IngestionInputConfigurationTypeDef, # (1)
RoleArn: str,
ClientToken: str,
) -> StartDataIngestionJobResponseTypeDef: # (2)
...
# start_data_ingestion_job method usage example with argument unpacking
kwargs: StartDataIngestionJobRequestRequestTypeDef = { # (1)
"DatasetName": ...,
"IngestionInputConfiguration": ...,
"RoleArn": ...,
"ClientToken": ...,
}
parent.start_data_ingestion_job(**kwargs)
start_inference_scheduler#
Starts an inference scheduler.
Type annotations and code completion for boto3.client("lookoutequipment").start_inference_scheduler
method.
boto3 documentation
# start_inference_scheduler method definition
def start_inference_scheduler(
self,
*,
InferenceSchedulerName: str,
) -> StartInferenceSchedulerResponseTypeDef: # (1)
...
# start_inference_scheduler method usage example with argument unpacking
kwargs: StartInferenceSchedulerRequestRequestTypeDef = { # (1)
"InferenceSchedulerName": ...,
}
parent.start_inference_scheduler(**kwargs)
stop_inference_scheduler#
Stops an inference scheduler.
Type annotations and code completion for boto3.client("lookoutequipment").stop_inference_scheduler
method.
boto3 documentation
# stop_inference_scheduler method definition
def stop_inference_scheduler(
self,
*,
InferenceSchedulerName: str,
) -> StopInferenceSchedulerResponseTypeDef: # (1)
...
# stop_inference_scheduler method usage example with argument unpacking
kwargs: StopInferenceSchedulerRequestRequestTypeDef = { # (1)
"InferenceSchedulerName": ...,
}
parent.stop_inference_scheduler(**kwargs)
tag_resource#
Associates a given tag to a resource in your account.
Type annotations and code completion for boto3.client("lookoutequipment").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes a specific tag from a given resource.
Type annotations and code completion for boto3.client("lookoutequipment").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_inference_scheduler#
Updates an inference scheduler.
Type annotations and code completion for boto3.client("lookoutequipment").update_inference_scheduler
method.
boto3 documentation
# update_inference_scheduler method definition
def update_inference_scheduler(
self,
*,
InferenceSchedulerName: str,
DataDelayOffsetInMinutes: int = ...,
DataUploadFrequency: DataUploadFrequencyType = ..., # (1)
DataInputConfiguration: InferenceInputConfigurationTypeDef = ..., # (2)
DataOutputConfiguration: InferenceOutputConfigurationTypeDef = ..., # (3)
RoleArn: str = ...,
) -> EmptyResponseMetadataTypeDef: # (4)
...
- See DataUploadFrequencyType
- See InferenceInputConfigurationTypeDef
- See InferenceOutputConfigurationTypeDef
- See EmptyResponseMetadataTypeDef
# update_inference_scheduler method usage example with argument unpacking
kwargs: UpdateInferenceSchedulerRequestRequestTypeDef = { # (1)
"InferenceSchedulerName": ...,
}
parent.update_inference_scheduler(**kwargs)
update_label_group#
Updates the label group.
Type annotations and code completion for boto3.client("lookoutequipment").update_label_group
method.
boto3 documentation
# update_label_group method definition
def update_label_group(
self,
*,
LabelGroupName: str,
FaultCodes: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# update_label_group method usage example with argument unpacking
kwargs: UpdateLabelGroupRequestRequestTypeDef = { # (1)
"LabelGroupName": ...,
}
parent.update_label_group(**kwargs)