Skip to content

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)
    ...
  1. See DatasetSchemaTypeDef
  2. See TagTypeDef
  3. See CreateDatasetResponseTypeDef
# create_dataset method usage example with argument unpacking

kwargs: CreateDatasetRequestRequestTypeDef = {  # (1)
    "DatasetName": ...,
    "ClientToken": ...,
}

parent.create_dataset(**kwargs)
  1. See CreateDatasetRequestRequestTypeDef

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)
    ...
  1. See DataUploadFrequencyType
  2. See InferenceInputConfigurationTypeDef
  3. See InferenceOutputConfigurationTypeDef
  4. See TagTypeDef
  5. 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)
  1. See CreateInferenceSchedulerRequestRequestTypeDef

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)
    ...
  1. See LabelRatingType
  2. See CreateLabelResponseTypeDef
# create_label method usage example with argument unpacking

kwargs: CreateLabelRequestRequestTypeDef = {  # (1)
    "LabelGroupName": ...,
    "StartTime": ...,
    "EndTime": ...,
    "Rating": ...,
    "ClientToken": ...,
}

parent.create_label(**kwargs)
  1. See CreateLabelRequestRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CreateLabelGroupResponseTypeDef
# create_label_group method usage example with argument unpacking

kwargs: CreateLabelGroupRequestRequestTypeDef = {  # (1)
    "LabelGroupName": ...,
    "ClientToken": ...,
}

parent.create_label_group(**kwargs)
  1. See CreateLabelGroupRequestRequestTypeDef

create_model#

Creates a machine learning 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 = ...,
    ModelDiagnosticsOutputConfiguration: ModelDiagnosticsOutputConfigurationTypeDef = ...,  # (5)
) -> CreateModelResponseTypeDef:  # (6)
    ...
  1. See DatasetSchemaTypeDef
  2. See LabelsInputConfigurationTypeDef
  3. See DataPreProcessingConfigurationTypeDef
  4. See TagTypeDef
  5. See ModelDiagnosticsOutputConfigurationTypeDef
  6. See CreateModelResponseTypeDef
# create_model method usage example with argument unpacking

kwargs: CreateModelRequestRequestTypeDef = {  # (1)
    "ModelName": ...,
    "DatasetName": ...,
    "ClientToken": ...,
}

parent.create_model(**kwargs)
  1. See CreateModelRequestRequestTypeDef

create_retraining_scheduler#

Creates a retraining scheduler on the specified model.

Type annotations and code completion for boto3.client("lookoutequipment").create_retraining_scheduler method. boto3 documentation

# create_retraining_scheduler method definition

def create_retraining_scheduler(
    self,
    *,
    ModelName: str,
    RetrainingFrequency: str,
    LookbackWindow: str,
    ClientToken: str,
    RetrainingStartDate: Union[datetime, str] = ...,
    PromoteMode: ModelPromoteModeType = ...,  # (1)
) -> CreateRetrainingSchedulerResponseTypeDef:  # (2)
    ...
  1. See ModelPromoteModeType
  2. See CreateRetrainingSchedulerResponseTypeDef
# create_retraining_scheduler method usage example with argument unpacking

kwargs: CreateRetrainingSchedulerRequestRequestTypeDef = {  # (1)
    "ModelName": ...,
    "RetrainingFrequency": ...,
    "LookbackWindow": ...,
    "ClientToken": ...,
}

parent.create_retraining_scheduler(**kwargs)
  1. See CreateRetrainingSchedulerRequestRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_dataset method usage example with argument unpacking

kwargs: DeleteDatasetRequestRequestTypeDef = {  # (1)
    "DatasetName": ...,
}

parent.delete_dataset(**kwargs)
  1. See DeleteDatasetRequestRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_inference_scheduler method usage example with argument unpacking

kwargs: DeleteInferenceSchedulerRequestRequestTypeDef = {  # (1)
    "InferenceSchedulerName": ...,
}

parent.delete_inference_scheduler(**kwargs)
  1. See DeleteInferenceSchedulerRequestRequestTypeDef

delete_label#

Deletes a label.

Type annotations and code completion for boto3.client("lookoutequipment").delete_label method.