libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.CreateProvisioningTemplate

Description

Creates a fleet provisioning template.

Requires permission to access the CreateProvisioningTemplate action.

Synopsis

Creating a Request

data CreateProvisioningTemplate Source #

See: newCreateProvisioningTemplate smart constructor.

Constructors

CreateProvisioningTemplate' 

Fields

  • preProvisioningHook :: Maybe ProvisioningHook

    Creates a pre-provisioning hook template.

  • enabled :: Maybe Bool

    True to enable the fleet provisioning template, otherwise false.

  • description :: Maybe Text

    The description of the fleet provisioning template.

  • tags :: Maybe [Tag]

    Metadata which can be used to manage the fleet provisioning template.

    For URI Request parameters use format: ...key1=value1&key2=value2...

    For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

    For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

  • templateName :: Text

    The name of the fleet provisioning template.

  • templateBody :: Text

    The JSON formatted contents of the fleet provisioning template.

  • provisioningRoleArn :: Text

    The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.

Instances

Instances details
Eq CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

Read CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

Show CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

Generic CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

Associated Types

type Rep CreateProvisioningTemplate :: Type -> Type #

NFData CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

Hashable CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

ToJSON CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

AWSRequest CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

ToHeaders CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

ToPath CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

ToQuery CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

type Rep CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

type Rep CreateProvisioningTemplate = D1 ('MetaData "CreateProvisioningTemplate" "Amazonka.IoT.CreateProvisioningTemplate" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "CreateProvisioningTemplate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "preProvisioningHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisioningHook)) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "provisioningRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateProvisioningTemplate Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

newCreateProvisioningTemplate Source #

Create a value of CreateProvisioningTemplate 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:preProvisioningHook:CreateProvisioningTemplate', createProvisioningTemplate_preProvisioningHook - Creates a pre-provisioning hook template.

$sel:enabled:CreateProvisioningTemplate', createProvisioningTemplate_enabled - True to enable the fleet provisioning template, otherwise false.

$sel:description:CreateProvisioningTemplate', createProvisioningTemplate_description - The description of the fleet provisioning template.

$sel:tags:CreateProvisioningTemplate', createProvisioningTemplate_tags - Metadata which can be used to manage the fleet provisioning template.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

$sel:templateName:CreateProvisioningTemplate', createProvisioningTemplate_templateName - The name of the fleet provisioning template.

$sel:templateBody:CreateProvisioningTemplate', createProvisioningTemplate_templateBody - The JSON formatted contents of the fleet provisioning template.

$sel:provisioningRoleArn:CreateProvisioningTemplate', createProvisioningTemplate_provisioningRoleArn - The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.

Request Lenses

createProvisioningTemplate_enabled :: Lens' CreateProvisioningTemplate (Maybe Bool) Source #

True to enable the fleet provisioning template, otherwise false.

createProvisioningTemplate_description :: Lens' CreateProvisioningTemplate (Maybe Text) Source #

The description of the fleet provisioning template.

createProvisioningTemplate_tags :: Lens' CreateProvisioningTemplate (Maybe [Tag]) Source #

Metadata which can be used to manage the fleet provisioning template.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

createProvisioningTemplate_templateBody :: Lens' CreateProvisioningTemplate Text Source #

The JSON formatted contents of the fleet provisioning template.

createProvisioningTemplate_provisioningRoleArn :: Lens' CreateProvisioningTemplate Text Source #

The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.

Destructuring the Response

data CreateProvisioningTemplateResponse Source #

Constructors

CreateProvisioningTemplateResponse' 

Fields

Instances

Instances details
Eq CreateProvisioningTemplateResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

Read CreateProvisioningTemplateResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

Show CreateProvisioningTemplateResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

Generic CreateProvisioningTemplateResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

Associated Types

type Rep CreateProvisioningTemplateResponse :: Type -> Type #

NFData CreateProvisioningTemplateResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

type Rep CreateProvisioningTemplateResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateProvisioningTemplate

type Rep CreateProvisioningTemplateResponse = D1 ('MetaData "CreateProvisioningTemplateResponse" "Amazonka.IoT.CreateProvisioningTemplate" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "CreateProvisioningTemplateResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "templateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateProvisioningTemplateResponse Source #

Create a value of CreateProvisioningTemplateResponse 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:templateName:CreateProvisioningTemplate', createProvisioningTemplateResponse_templateName - The name of the fleet provisioning template.

$sel:defaultVersionId:CreateProvisioningTemplateResponse', createProvisioningTemplateResponse_defaultVersionId - The default version of the fleet provisioning template.

$sel:templateArn:CreateProvisioningTemplateResponse', createProvisioningTemplateResponse_templateArn - The ARN that identifies the provisioning template.

$sel:httpStatus:CreateProvisioningTemplateResponse', createProvisioningTemplateResponse_httpStatus - The response's http status code.

Response Lenses