Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoT.CreateProvisioningTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a provisioning template.

Requires permission to access the CreateProvisioningTemplate action.

Synopsis

Creating a Request

data CreateProvisioningTemplate Source #

See: newCreateProvisioningTemplate smart constructor.

Constructors

CreateProvisioningTemplate'

Fields

description :: Maybe Text
The description of the provisioning template.
enabled :: Maybe Bool
True to enable the provisioning template, otherwise false.
preProvisioningHook :: Maybe ProvisioningHook
Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.
tags :: Maybe [Tag]
Metadata which can be used to manage the 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..."
type' :: Maybe TemplateType
The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.
templateName :: Text
The name of the provisioning template.
templateBody :: Text
The JSON formatted contents of the provisioning template.
provisioningRoleArn :: Text
The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.

Instances

Instances details

ToJSON CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods toJSON :: CreateProvisioningTemplate -> Value # toEncoding :: CreateProvisioningTemplate -> Encoding # toJSONList :: [CreateProvisioningTemplate] -> Value # toEncodingList :: [CreateProvisioningTemplate] -> Encoding #
ToHeaders CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods toHeaders :: CreateProvisioningTemplate -> [Header] #
ToPath CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods toPath :: CreateProvisioningTemplate -> ByteString #
ToQuery CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods toQuery :: CreateProvisioningTemplate -> QueryString #
AWSRequest CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Associated Types type AWSResponse CreateProvisioningTemplate # Methods request :: (Service -> Service) -> CreateProvisioningTemplate -> Request CreateProvisioningTemplate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateProvisioningTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateProvisioningTemplate))) #
Generic CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Associated Types type Rep CreateProvisioningTemplate :: Type -> Type # Methods from :: CreateProvisioningTemplate -> Rep CreateProvisioningTemplate x # to :: Rep CreateProvisioningTemplate x -> CreateProvisioningTemplate #
Read CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods readsPrec :: Int -> ReadS CreateProvisioningTemplate # readList :: ReadS [CreateProvisioningTemplate] # readPrec :: ReadPrec CreateProvisioningTemplate # readListPrec :: ReadPrec [CreateProvisioningTemplate] #
Show CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods showsPrec :: Int -> CreateProvisioningTemplate -> ShowS # show :: CreateProvisioningTemplate -> String # showList :: [CreateProvisioningTemplate] -> ShowS #
NFData CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods rnf :: CreateProvisioningTemplate -> () #
Eq CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods (==) :: CreateProvisioningTemplate -> CreateProvisioningTemplate -> Bool # (/=) :: CreateProvisioningTemplate -> CreateProvisioningTemplate -> Bool #
Hashable CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods hashWithSalt :: Int -> CreateProvisioningTemplate -> Int # hash :: CreateProvisioningTemplate -> Int #
type AWSResponse CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate type AWSResponse CreateProvisioningTemplate = CreateProvisioningTemplateResponse
type Rep CreateProvisioningTemplate Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate type Rep CreateProvisioningTemplate = D1 ('MetaData "CreateProvisioningTemplate" "Amazonka.IoT.CreateProvisioningTemplate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateProvisioningTemplate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "preProvisioningHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisioningHook)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: ((S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateType)) :: 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)))))

newCreateProvisioningTemplate Source #

Arguments

:: Text	`CreateProvisioningTemplate`
-> Text	`CreateProvisioningTemplate`
-> Text	`$sel:provisioningRoleArn:CreateProvisioningTemplate'`
-> CreateProvisioningTemplate

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:

CreateProvisioningTemplate, createProvisioningTemplate_description - The description of the provisioning template.

CreateProvisioningTemplate, createProvisioningTemplate_enabled - True to enable the provisioning template, otherwise false.

$sel:preProvisioningHook:CreateProvisioningTemplate', createProvisioningTemplate_preProvisioningHook - Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.

$sel:tags:CreateProvisioningTemplate', createProvisioningTemplate_tags - Metadata which can be used to manage the 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, createProvisioningTemplate_type - The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.

CreateProvisioningTemplate, createProvisioningTemplate_templateName - The name of the provisioning template.

CreateProvisioningTemplate, createProvisioningTemplate_templateBody - The JSON formatted contents of the provisioning template.

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

Request Lenses

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

The description of the provisioning template.

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

True to enable the provisioning template, otherwise false.

createProvisioningTemplate_preProvisioningHook :: Lens' CreateProvisioningTemplate (Maybe ProvisioningHook) Source #

Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.

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

Metadata which can be used to manage the 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_type :: Lens' CreateProvisioningTemplate (Maybe TemplateType) Source #

The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.

createProvisioningTemplate_templateName :: Lens' CreateProvisioningTemplate Text Source #

The name of the provisioning template.

createProvisioningTemplate_templateBody :: Lens' CreateProvisioningTemplate Text Source #

The JSON formatted contents of the provisioning template.

createProvisioningTemplate_provisioningRoleArn :: Lens' CreateProvisioningTemplate Text Source #

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

Destructuring the Response

data CreateProvisioningTemplateResponse Source #

See: newCreateProvisioningTemplateResponse smart constructor.

Constructors

CreateProvisioningTemplateResponse'
Fields defaultVersionId :: Maybe Int The default version of the provisioning template. templateArn :: Maybe Text The ARN that identifies the provisioning template. templateName :: Maybe Text The name of the provisioning template. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateProvisioningTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Associated Types type Rep CreateProvisioningTemplateResponse :: Type -> Type # Methods from :: CreateProvisioningTemplateResponse -> Rep CreateProvisioningTemplateResponse x # to :: Rep CreateProvisioningTemplateResponse x -> CreateProvisioningTemplateResponse #
Read CreateProvisioningTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods readsPrec :: Int -> ReadS CreateProvisioningTemplateResponse # readList :: ReadS [CreateProvisioningTemplateResponse] # readPrec :: ReadPrec CreateProvisioningTemplateResponse # readListPrec :: ReadPrec [CreateProvisioningTemplateResponse] #
Show CreateProvisioningTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods showsPrec :: Int -> CreateProvisioningTemplateResponse -> ShowS # show :: CreateProvisioningTemplateResponse -> String # showList :: [CreateProvisioningTemplateResponse] -> ShowS #
NFData CreateProvisioningTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods rnf :: CreateProvisioningTemplateResponse -> () #
Eq CreateProvisioningTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate Methods (==) :: CreateProvisioningTemplateResponse -> CreateProvisioningTemplateResponse -> Bool # (/=) :: CreateProvisioningTemplateResponse -> CreateProvisioningTemplateResponse -> Bool #
type Rep CreateProvisioningTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateProvisioningTemplate type Rep CreateProvisioningTemplateResponse = D1 ('MetaData "CreateProvisioningTemplateResponse" "Amazonka.IoT.CreateProvisioningTemplate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateProvisioningTemplateResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "templateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateProvisioningTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateProvisioningTemplateResponse'`
-> CreateProvisioningTemplateResponse

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:defaultVersionId:CreateProvisioningTemplateResponse', createProvisioningTemplateResponse_defaultVersionId - The default version of the provisioning template.

CreateProvisioningTemplateResponse, createProvisioningTemplateResponse_templateArn - The ARN that identifies the provisioning template.

CreateProvisioningTemplate, createProvisioningTemplateResponse_templateName - The name of the provisioning template.

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

Response Lenses

createProvisioningTemplateResponse_defaultVersionId :: Lens' CreateProvisioningTemplateResponse (Maybe Int) Source #

The default version of the provisioning template.

createProvisioningTemplateResponse_templateArn :: Lens' CreateProvisioningTemplateResponse (Maybe Text) Source #

The ARN that identifies the provisioning template.

createProvisioningTemplateResponse_templateName :: Lens' CreateProvisioningTemplateResponse (Maybe Text) Source #

The name of the provisioning template.

createProvisioningTemplateResponse_httpStatus :: Lens' CreateProvisioningTemplateResponse Int Source #

The response's http status code.