IoT / Client / update_provisioning_template

update_provisioning_template#

IoT.Client.update_provisioning_template(**kwargs)#

Updates a provisioning template.

Requires permission to access the UpdateProvisioningTemplate action.

See also: AWS API Documentation

Request Syntax

response = client.update_provisioning_template(
    templateName='string',
    description='string',
    enabled=True|False,
    defaultVersionId=123,
    provisioningRoleArn='string',
    preProvisioningHook={
        'payloadVersion': 'string',
        'targetArn': 'string'
    },
    removePreProvisioningHook=True|False
)
Parameters:

  • templateName (string) –

    [REQUIRED]

    The name of the provisioning template.

  • description (string) – The description of the provisioning template.

  • enabled (boolean) – True to enable the provisioning template, otherwise false.

  • defaultVersionId (integer) – The ID of the default provisioning template version.

  • provisioningRoleArn (string) – The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.

  • preProvisioningHook (dict) –

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

    • payloadVersion (string) –

      The payload that was sent to the target function.

      Note: Only Lambda functions are currently supported.

    • targetArn (string) – [REQUIRED]

      The ARN of the target function.

      Note: Only Lambda functions are currently supported.

  • removePreProvisioningHook (boolean) – Removes pre-provisioning hook template.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • IoT.Client.exceptions.InternalFailureException

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ResourceNotFoundException

  • IoT.Client.exceptions.UnauthorizedException

  • IoT.Client.exceptions.ConflictingResourceUpdateException