label_groups

Creates, updates, deletes, gets or lists a label_groups resource.

Overview

Name	label_groups
Type	Resource
Id	aws.lookoutequipment.label_groups

Fields

The following fields are returned by SELECT queries:

describe_label_group

Name	Datatype	Description
created_at	string (date-time)	The time at which the label group was created.
fault_codes	array	Codes indicating the type of anomaly associated with the labels in the lagbel group.
label_group_arn	string	The Amazon Resource Name (ARN) of the label group. (pattern: <code>arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9-]*:[0-9]{12}:label-group/.+</code>)
label_group_name	string	The name of the label group. (pattern: <code>^[0-9a-zA-Z_-]{1,200}$</code>)
updated_at	string (date-time)	The time at which the label group was updated.

list_label_groups

Name	Datatype	Description
label_group_summaries	array	A summary of the label groups.
next_token	string	An opaque pagination token indicating where to continue the listing of label groups. (pattern: <code>\p{ASCII}{0,8192}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_label_group	select	region		Returns information about the label group.
list_label_groups	select	region		Returns a list of the label groups.
create_label_group	insert	region, LabelGroupName, ClientToken		Creates a group of labels.
update_label_group	update	region, LabelGroupName		Updates the label group.
delete_label_group	delete	region		Deletes a group of labels.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_label_group

Returns information about the label group.

SELECT
created_at,
fault_codes,
label_group_arn,
label_group_name,
updated_at
FROM aws.lookoutequipment.label_groups
WHERE region = '{{ region }}' -- required
;

list_label_groups

Returns a list of the label groups.

SELECT
label_group_summaries,
next_token
FROM aws.lookoutequipment.label_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_label_group

Creates a group of labels.

INSERT INTO aws.lookoutequipment.label_groups (
LabelGroupName,
FaultCodes,
ClientToken,
Tags,
region
)
SELECT 
'{{ LabelGroupName }}' /* required */,
'{{ FaultCodes }}',
'{{ ClientToken }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
label_group_arn,
label_group_name
;

Manifest

# Description fields are for documentation purposes
- name: label_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the label_groups resource.
  - name: LabelGroupName
    value: "{{ LabelGroupName }}"
    description: |
      Names a group of labels. Data in this field will be retained for service usage. Follow best practices for the security of your data.
  - name: FaultCodes
    value:
      - "{{ FaultCodes }}"
    description: |
      The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group. Data in this field will be retained for service usage. Follow best practices for the security of your data.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.
  - name: Tags
    description: |
      Tags that provide metadata about the label group you are creating. Data in this field will be retained for service usage. Follow best practices for the security of your data.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_label_group

Updates the label group.

UPDATE aws.lookoutequipment.label_groups
SET 
LabelGroupName = '{{ LabelGroupName }}',
FaultCodes = '{{ FaultCodes }}'
WHERE 
region = '{{ region }}' --required
AND LabelGroupName = '{{ LabelGroupName }}' --required;

DELETE examples

delete_label_group

Deletes a group of labels.

DELETE FROM aws.lookoutequipment.label_groups
WHERE region = '{{ region }}' --required
;