Skip to content

LookoutEquipmentClient

Index > LookoutEquipment > LookoutEquipmentClient

Auto-generated documentation for LookoutEquipment type annotations stubs module types-aiobotocore-lookoutequipment.

LookoutEquipmentClient

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

Usage example
from aioboto3.session import Session
from types_aiobotocore_lookoutequipment.client import LookoutEquipmentClient

session = Session()
async with session.client("lookoutequipment") as client:
    client: LookoutEquipmentClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("lookoutequipment").exceptions structure.

Usage example
async with session.client("lookoutequipment") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.ClientError,
        client.ConflictException,
        client.InternalServerException,
        client.ResourceNotFoundException,
        client.ServiceQuotaExceededException,
        client.ThrottlingException,
        client.ValidationException,
    ) as e:
        print(e)
Type checking example
from types_aiobotocore_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 session.client("lookoutequipment").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

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

Method definition
await def close(
    self,
) -> None:
    ...

create_dataset

Creates a container for a collection of data being ingested for analysis.

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

Method definition
await 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
Usage example with kwargs
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 session.client("lookoutequipment").create_inference_scheduler method. boto3 documentation

Method definition
await 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
Usage example with kwargs
kwargs: CreateInferenceSchedulerRequestRequestTypeDef = {  # (1)
    "ModelName": ...,
    "InferenceSchedulerName": ...,
    "DataUploadFrequency": ...,
    "DataInputConfiguration": ...,
    "DataOutputConfiguration": ...,
    "RoleArn": ...,
    "ClientToken": ...,
}

parent.create_inference_scheduler(**kwargs)
  1. See CreateInferenceSchedulerRequestRequestTypeDef

create_model

Creates an ML model for data inference.

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

Method definition
await 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)
    ...
  1. See DatasetSchemaTypeDef
  2. See LabelsInputConfigurationTypeDef
  3. See DataPreProcessingConfigurationTypeDef
  4. See TagTypeDef
  5. See CreateModelResponseTypeDef
Usage example with kwargs
kwargs: CreateModelRequestRequestTypeDef = {  # (1)
    "ModelName": ...,
    "DatasetName": ...,
    "ClientToken": ...,
}

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

delete_dataset

Deletes a dataset and associated artifacts.

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

Method definition
await def delete_dataset(
    self,
    *,
    DatasetName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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 session.client("lookoutequipment").delete_inference_scheduler method. boto3 documentation

Method definition
await def delete_inference_scheduler(
    self,
    *,
    InferenceSchedulerName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteInferenceSchedulerRequestRequestTypeDef = {  # (1)
    "InferenceSchedulerName": ...,
}

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

delete_model

Deletes an ML model currently available for Amazon Lookout for Equipment.

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

Method definition
await def delete_model(
    self,
    *,
    ModelName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteModelRequestRequestTypeDef = {  # (1)
    "ModelName": ...,
}

parent.delete_model(**kwargs)
  1. See DeleteModelRequestRequestTypeDef

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 session.client("lookoutequipment").describe_data_ingestion_job method. boto3 documentation

Method definition
await def describe_data_ingestion_job(
    self,
    *,
    JobId: str,
) -> DescribeDataIngestionJobResponseTypeDef:  # (1)
    ...
  1. See DescribeDataIngestionJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeDataIngestionJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_data_ingestion_job(**kwargs)
  1. See DescribeDataIngestionJobRequestRequestTypeDef

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 session.client("lookoutequipment").describe_dataset method. boto3 documentation

Method definition
await def describe_dataset(
    self,
    *,
    DatasetName: str,
) -> DescribeDatasetResponseTypeDef:  # (1)
    ...
  1. See DescribeDatasetResponseTypeDef
Usage example with kwargs
kwargs: DescribeDatasetRequestRequestTypeDef = {  # (1)
    "DatasetName": ...,
}

parent.describe_dataset(**kwargs)
  1. See DescribeDatasetRequestRequestTypeDef

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 session.client("lookoutequipment").describe_inference_scheduler method. boto3 documentation

Method definition
await def describe_inference_scheduler(
    self,
    *,
    InferenceSchedulerName: str,
) -> DescribeInferenceSchedulerResponseTypeDef:  # (1)
    ...
  1. See DescribeInferenceSchedulerResponseTypeDef
Usage example with kwargs
kwargs: DescribeInferenceSchedulerRequestRequestTypeDef = {  # (1)
    "InferenceSchedulerName": ...,
}

parent.describe_inference_scheduler(**kwargs)
  1. See DescribeInferenceSchedulerRequestRequestTypeDef

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 session.client("lookoutequipment").describe_model method. boto3 documentation

Method definition
await def describe_model(
    self,
    *,
    ModelName: str,
) -> DescribeModelResponseTypeDef:  # (1)
    ...
  1. See DescribeModelResponseTypeDef
Usage example with kwargs
kwargs: DescribeModelRequestRequestTypeDef = {  # (1)
    "ModelName": ...,
}

parent.describe_model(**kwargs)
  1. See DescribeModelRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition
await 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 session.client("lookoutequipment").list_data_ingestion_jobs method. boto3 documentation

Method definition
await def list_data_ingestion_jobs(
    self,
    *,
    DatasetName: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    Status: IngestionJobStatusType = ...,  # (1)
) -> ListDataIngestionJobsResponseTypeDef:  # (2)
    ...
  1. See IngestionJobStatusType
  2. See ListDataIngestionJobsResponseTypeDef
Usage example with kwargs
kwargs: ListDataIngestionJobsRequestRequestTypeDef = {  # (1)
    "DatasetName": ...,
}

parent.list_data_ingestion_jobs(**kwargs)
  1. See ListDataIngestionJobsRequestRequestTypeDef

list_datasets

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

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

Method definition
await def list_datasets(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    DatasetNameBeginsWith: str = ...,
) -> ListDatasetsResponseTypeDef:  # (1)
    ...
  1. See ListDatasetsResponseTypeDef
Usage example with kwargs
kwargs: ListDatasetsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_datasets(**kwargs)
  1. See ListDatasetsRequestRequestTypeDef

list_inference_events

Lists all inference events that have been found for the specified inference scheduler.

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

Method definition
await def list_inference_events(
    self,
    *,
    InferenceSchedulerName: str,
    IntervalStartTime: Union[datetime, str],
    IntervalEndTime: Union[datetime, str],
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListInferenceEventsResponseTypeDef:  # (1)
    ...
  1. See ListInferenceEventsResponseTypeDef
Usage example with kwargs
kwargs: ListInferenceEventsRequestRequestTypeDef = {  # (1)
    "InferenceSchedulerName": ...,
    "IntervalStartTime": ...,
    "IntervalEndTime": ...,
}

parent.list_inference_events(**kwargs)
  1. See ListInferenceEventsRequestRequestTypeDef

list_inference_executions

Lists all inference executions that have been performed by the specified inference scheduler.

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

Method definition
await def list_inference_executions(
    self,
    *,
    InferenceSchedulerName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    DataStartTimeAfter: Union[datetime, str] = ...,
    DataEndTimeBefore: Union[datetime, str] = ...,
    Status: InferenceExecutionStatusType = ...,  # (1)
) -> ListInferenceExecutionsResponseTypeDef:  # (2)
    ...
  1. See InferenceExecutionStatusType
  2. See ListInferenceExecutionsResponseTypeDef
Usage example with kwargs
kwargs: ListInferenceExecutionsRequestRequestTypeDef = {  # (1)
    "InferenceSchedulerName": ...,
}

parent.list_inference_executions(**kwargs)
  1. See ListInferenceExecutionsRequestRequestTypeDef

list_inference_schedulers

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

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

Method definition
await def list_inference_schedulers(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    InferenceSchedulerNameBeginsWith: str = ...,
    ModelName: str = ...,
) -> ListInferenceSchedulersResponseTypeDef:  # (1)
    ...
  1. See ListInferenceSchedulersResponseTypeDef
Usage example with kwargs
kwargs: ListInferenceSchedulersRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_inference_schedulers(**kwargs)
  1. See ListInferenceSchedulersRequestRequestTypeDef

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 session.client("lookoutequipment").list_models method. boto3 documentation

Method definition
await def list_models(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Status: ModelStatusType = ...,  # (1)
    ModelNameBeginsWith: str = ...,
    DatasetNameBeginsWith: str = ...,
) -> ListModelsResponseTypeDef:  # (2)
    ...
  1. See ModelStatusType
  2. See ListModelsResponseTypeDef
Usage example with kwargs
kwargs: ListModelsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_models(**kwargs)
  1. See ListModelsRequestRequestTypeDef

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 session.client("lookoutequipment").list_sensor_statistics method. boto3 documentation

Method definition
await def list_sensor_statistics(
    self,
    *,
    DatasetName: str,
    IngestionJobId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSensorStatisticsResponseTypeDef:  # (1)
    ...
  1. See ListSensorStatisticsResponseTypeDef
Usage example with kwargs
kwargs: ListSensorStatisticsRequestRequestTypeDef = {  # (1)
    "DatasetName": ...,
}

parent.list_sensor_statistics(**kwargs)
  1. See ListSensorStatisticsRequestRequestTypeDef

list_tags_for_resource

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

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

Method definition
await def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

start_data_ingestion_job

Starts a data ingestion job.

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

Method definition
await def start_data_ingestion_job(
    self,
    *,
    DatasetName: str,
    IngestionInputConfiguration: IngestionInputConfigurationTypeDef,  # (1)
    RoleArn: str,
    ClientToken: str,
) -> StartDataIngestionJobResponseTypeDef:  # (2)
    ...
  1. See IngestionInputConfigurationTypeDef
  2. See StartDataIngestionJobResponseTypeDef
Usage example with kwargs
kwargs: StartDataIngestionJobRequestRequestTypeDef = {  # (1)
    "DatasetName": ...,
    "IngestionInputConfiguration": ...,
    "RoleArn": ...,
    "ClientToken": ...,
}

parent.start_data_ingestion_job(**kwargs)
  1. See StartDataIngestionJobRequestRequestTypeDef

start_inference_scheduler

Starts an inference scheduler.

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

Method definition
await def start_inference_scheduler(
    self,
    *,
    InferenceSchedulerName: str,
) -> StartInferenceSchedulerResponseTypeDef:  # (1)
    ...
  1. See StartInferenceSchedulerResponseTypeDef
Usage example with kwargs
kwargs: StartInferenceSchedulerRequestRequestTypeDef = {  # (1)
    "InferenceSchedulerName": ...,
}

parent.start_inference_scheduler(**kwargs)
  1. See StartInferenceSchedulerRequestRequestTypeDef

stop_inference_scheduler

Stops an inference scheduler.

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

Method definition
await def stop_inference_scheduler(
    self,
    *,
    InferenceSchedulerName: str,
) -> StopInferenceSchedulerResponseTypeDef:  # (1)
    ...
  1. See StopInferenceSchedulerResponseTypeDef
Usage example with kwargs
kwargs: StopInferenceSchedulerRequestRequestTypeDef = {  # (1)
    "InferenceSchedulerName": ...,
}

parent.stop_inference_scheduler(**kwargs)
  1. See StopInferenceSchedulerRequestRequestTypeDef

tag_resource

Associates a given tag to a resource in your account.

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

Method definition
await def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a specific tag from a given resource.

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

Method definition
await def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_inference_scheduler

Updates an inference scheduler.

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

Method definition
await def update_inference_scheduler(
    self,
    *,
    InferenceSchedulerName: str,
    DataDelayOffsetInMinutes: int = ...,
    DataUploadFrequency: DataUploadFrequencyType = ...,  # (1)
    DataInputConfiguration: InferenceInputConfigurationTypeDef = ...,  # (2)
    DataOutputConfiguration: InferenceOutputConfigurationTypeDef = ...,  # (3)
    RoleArn: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (4)
    ...
  1. See DataUploadFrequencyType
  2. See InferenceInputConfigurationTypeDef
  3. See InferenceOutputConfigurationTypeDef
  4. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: UpdateInferenceSchedulerRequestRequestTypeDef = {  # (1)
    "InferenceSchedulerName": ...,
}

parent.update_inference_scheduler(**kwargs)
  1. See UpdateInferenceSchedulerRequestRequestTypeDef

__aenter__

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

Method definition
await def __aenter__(
    self,
) -> LookoutEquipmentClient:
    ...

__aexit__

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

Method definition
await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...