Skip to content

CreateProvisioningTemplateRequest

Source code in docs_src/capo_iot/types/create_provisioning_template_request.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class CreateProvisioningTemplateRequest(TypedDict, closed=True):
    template_name: "capo_iot.types.template_name.TemplateName"
    """<p>The name of the provisioning template.</p>"""
    description: NotRequired["capo_iot.types.template_description.TemplateDescription"]
    """<p>The description of the provisioning template.</p>"""
    template_body: "capo_iot.types.template_body.TemplateBody"
    """<p>The JSON formatted contents of the provisioning template.</p>"""
    enabled: NotRequired["capo_iot.types.enabled2.Enabled2"]
    """<p>True to enable the provisioning template, otherwise false.</p>"""
    provisioning_role_arn: "capo_iot.types.role_arn.RoleArn"
    """<p>The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.</p>"""
    pre_provisioning_hook: NotRequired[
        "capo_iot.types.provisioning_hook.ProvisioningHook"
    ]
    """<p>Creates a pre-provisioning hook template. Only supports template of type <code>FLEET_PROVISIONING</code>. For more information about provisioning template types, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_CreateProvisioningTemplate.html#iot-CreateProvisioningTemplate-request-type">type</a>.</p>"""
    tags: NotRequired["capo_iot.types.tag_list.TagList"]
    """<p>Metadata which can be used to manage the provisioning template.</p> <note> <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p> <p>For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."</p> <p>For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."</p> </note>"""
    type: NotRequired["capo_iot.types.template_type.TemplateType"]
    """<p>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 <code>FLEET_PROVISIONING</code>. For more information about provisioning template, see: <a href="https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html">Provisioning template</a>. </p>"""

description instance-attribute 

description: NotRequired[TemplateDescription]

The description of the provisioning template.

enabled instance-attribute 

enabled: NotRequired[Enabled2]

True to enable the provisioning template, otherwise false.

pre_provisioning_hook instance-attribute 

pre_provisioning_hook: NotRequired[ProvisioningHook]

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

provisioning_role_arn instance-attribute 

provisioning_role_arn: RoleArn

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

tags instance-attribute 

tags: NotRequired[TagList]

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..."

template_body instance-attribute 

template_body: TemplateBody

The JSON formatted contents of the provisioning template.

template_name instance-attribute 

template_name: TemplateName

The name of the provisioning template.

type instance-attribute 

type: NotRequired[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.