amazonka-lookoutequipment-2.0: Amazon Lookout for Equipment SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LookoutEquipment.CreateLabelGroup

Description

Creates a group of labels.

Synopsis

Creating a Request

data CreateLabelGroup Source #

See: newCreateLabelGroup smart constructor.

Constructors

CreateLabelGroup' 

Fields

  • faultCodes :: Maybe [Text]

    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.

  • tags :: Maybe [Tag]

    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.

  • labelGroupName :: Text

    Names a group of labels.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • clientToken :: Text

    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.

Instances

Instances details
ToJSON CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

ToHeaders CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

ToPath CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

ToQuery CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

AWSRequest CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

Associated Types

type AWSResponse CreateLabelGroup #

Generic CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

Associated Types

type Rep CreateLabelGroup :: Type -> Type #

Read CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

Show CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

NFData CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

Methods

rnf :: CreateLabelGroup -> () #

Eq CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

Hashable CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

type AWSResponse CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

type Rep CreateLabelGroup Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

type Rep CreateLabelGroup = D1 ('MetaData "CreateLabelGroup" "Amazonka.LookoutEquipment.CreateLabelGroup" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "CreateLabelGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "faultCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "labelGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateLabelGroup Source #

Create a value of CreateLabelGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:faultCodes:CreateLabelGroup', createLabelGroup_faultCodes - 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.

$sel:tags:CreateLabelGroup', createLabelGroup_tags - 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.

CreateLabelGroup, createLabelGroup_labelGroupName - Names a group of labels.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

$sel:clientToken:CreateLabelGroup', createLabelGroup_clientToken - 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.

Request Lenses

createLabelGroup_faultCodes :: Lens' CreateLabelGroup (Maybe [Text]) Source #

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.

createLabelGroup_tags :: Lens' CreateLabelGroup (Maybe [Tag]) Source #

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.

createLabelGroup_labelGroupName :: Lens' CreateLabelGroup Text Source #

Names a group of labels.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabelGroup_clientToken :: Lens' CreateLabelGroup Text Source #

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.

Destructuring the Response

data CreateLabelGroupResponse Source #

See: newCreateLabelGroupResponse smart constructor.

Constructors

CreateLabelGroupResponse' 

Fields

  • labelGroupArn :: Maybe Text

    The ARN of the label group that you have created.

  • labelGroupName :: Maybe Text

    The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateLabelGroupResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

Associated Types

type Rep CreateLabelGroupResponse :: Type -> Type #

Read CreateLabelGroupResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

Show CreateLabelGroupResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

NFData CreateLabelGroupResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

Eq CreateLabelGroupResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

type Rep CreateLabelGroupResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.CreateLabelGroup

type Rep CreateLabelGroupResponse = D1 ('MetaData "CreateLabelGroupResponse" "Amazonka.LookoutEquipment.CreateLabelGroup" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "CreateLabelGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "labelGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "labelGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateLabelGroupResponse Source #

Create a value of CreateLabelGroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateLabelGroupResponse, createLabelGroupResponse_labelGroupArn - The ARN of the label group that you have created.

CreateLabelGroup, createLabelGroupResponse_labelGroupName - The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.

$sel:httpStatus:CreateLabelGroupResponse', createLabelGroupResponse_httpStatus - The response's http status code.

Response Lenses

createLabelGroupResponse_labelGroupArn :: Lens' CreateLabelGroupResponse (Maybe Text) Source #

The ARN of the label group that you have created.

createLabelGroupResponse_labelGroupName :: Lens' CreateLabelGroupResponse (Maybe Text) Source #

The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.