Amazon Lookout for Equipment Lookout For Equipment Label API
The Lookout For Equipment Label API from Amazon Lookout for Equipment — 4 operation(s) for lookout for equipment label.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-lookout-for-equipment:amazon-lookout-for-equipment-label-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon Lookout for Equipment Label API
version: '2020-12-15'
description: Generated from AWS's published Smithy model for Amazon Lookout for Equipment. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://lookoutequipment.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Label
paths:
/#CreateLabel:
post:
operationId: CreateLabel
summary: Create Label
description: Creates a label for an event.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/CreateLabelResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSLookoutEquipmentFrontendService.CreateLabel
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/CreateLabelRequest'
tags:
- Label
/#DeleteLabel:
post:
operationId: DeleteLabel
summary: Delete Label
description: Deletes a label.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
type: string
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSLookoutEquipmentFrontendService.DeleteLabel
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DeleteLabelRequest'
tags:
- Label
/#DescribeLabel:
post:
operationId: DescribeLabel
summary: Describe Label
description: Returns the name of the label.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeLabelResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSLookoutEquipmentFrontendService.DescribeLabel
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeLabelRequest'
tags:
- Label
/#ListLabels:
post:
operationId: ListLabels
summary: List Labels
description: Provides a list of labels.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListLabelsResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSLookoutEquipmentFrontendService.ListLabels
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListLabelsRequest'
tags:
- Label
components:
schemas:
LabelSummary:
type: object
properties:
LabelGroupName:
type: string
description: The name of the label group.
LabelId:
type: string
description: The ID of the label.
LabelGroupArn:
type: string
description: The Amazon Resource Name (ARN) of the label group.
StartTime:
type: string
format: date-time
description: The timestamp indicating the start of the label.
EndTime:
type: string
format: date-time
description: The timestamp indicating the end of the label.
Rating:
type: string
enum:
- ANOMALY
- NO_ANOMALY
- NEUTRAL
description: Indicates whether a labeled event represents an anomaly.
FaultCode:
type: string
description: 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.
Equipment:
type: string
description: Indicates that a label pertains to a particular piece of equipment.
CreatedAt:
type: string
format: date-time
description: The time at which the label was created.
ResourceNotFoundException:
type: object
properties:
Message:
type: string
required:
- Message
ListLabelsRequest:
type: object
properties:
LabelGroupName:
type: string
description: Returns the name of the label group.
IntervalStartTime:
type: string
format: date-time
description: Returns all the labels with a end time equal to or later than the start time given.
IntervalEndTime:
type: string
format: date-time
description: Returns all labels with a start time earlier than the end time given.
FaultCode:
type: string
description: Returns labels with a particular fault code.
Equipment:
type: string
description: Lists the labels that pertain to a particular piece of equipment.
NextToken:
type: string
description: An opaque pagination token indicating where to continue the listing of label groups.
MaxResults:
type: integer
description: Specifies the maximum number of labels to list.
required:
- LabelGroupName
ServiceQuotaExceededException:
type: object
properties:
Message:
type: string
required:
- Message
DescribeLabelResponse:
type: object
properties:
LabelGroupName:
type: string
description: The name of the requested label group.
LabelGroupArn:
type: string
description: The Amazon Resource Name (ARN) of the requested label group.
LabelId:
type: string
description: The ID of the requested label.
StartTime:
type: string
format: date-time
description: The start time of the requested label.
EndTime:
type: string
format: date-time
description: The end time of the requested label.
Rating:
type: string
enum:
- ANOMALY
- NO_ANOMALY
- NEUTRAL
description: Indicates whether a labeled event represents an anomaly.
FaultCode:
type: string
description: 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.
Notes:
type: string
description: 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.
Equipment:
type: string
description: Indicates that a label pertains to a particular piece of equipment.
CreatedAt:
type: string
format: date-time
description: The time at which the label was created.
CreateLabelRequest:
type: object
properties:
LabelGroupName:
type: string
description: 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.
StartTime:
type: string
format: date-time
description: The start time of the labeled event.
EndTime:
type: string
format: date-time
description: The end time of the labeled event.
Rating:
type: string
enum:
- ANOMALY
- NO_ANOMALY
- NEUTRAL
description: Indicates whether a labeled event represents an anomaly.
FaultCode:
type: string
description: 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.
Notes:
type: string
description: 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.
Equipment:
type: string
description: 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.
ClientToken:
type: string
description: A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.
required:
- LabelGroupName
- StartTime
- EndTime
- Rating
- ClientToken
DescribeLabelRequest:
type: object
properties:
LabelGroupName:
type: string
description: Returns the name of the group containing the label.
LabelId:
type: string
description: Returns the ID of the label.
required:
- LabelGroupName
- LabelId
ListLabelsResponse:
type: object
properties:
NextToken:
type: string
description: An opaque pagination token indicating where to continue the listing of datasets.
LabelSummaries:
type: array
items:
$ref: '#/components/schemas/LabelSummary'
description: 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.
InternalServerException:
type: object
properties:
Message:
type: string
required:
- Message
AccessDeniedException:
type: object
properties:
Message:
type: string
required:
- Message
ConflictException:
type: object
properties:
Message:
type: string
required:
- Message
ThrottlingException:
type: object
properties:
Message:
type: string
required:
- Message
ValidationException:
type: object
properties:
Message:
type: string
required:
- Message
CreateLabelResponse:
type: object
properties:
LabelId:
type: string
description: The ID of the label that you have created.
DeleteLabelRequest:
type: object
properties:
LabelGroupName:
type: string
description: 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.
LabelId:
type: string
description: The ID of the label that you want to delete.
required:
- LabelGroupName
- LabelId
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: lookoutequipment
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/lookoutequipment/service/2020-12-15/lookoutequipment-2020-12-15.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)