[ aws . iot ]

update-provisioning-template

Description

Updates a fleet provisioning template.

Requires permission to access the UpdateProvisioningTemplate action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-provisioning-template
--template-name <value>
[--description <value>]
[--enabled | --no-enabled]
[--default-version-id <value>]
[--provisioning-role-arn <value>]
[--pre-provisioning-hook <value>]
[--remove-pre-provisioning-hook | --no-remove-pre-provisioning-hook]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--template-name (string)

The name of the fleet provisioning template.

--description (string)

The description of the fleet provisioning template.

--enabled | --no-enabled (boolean)

True to enable the fleet provisioning template, otherwise false.

--default-version-id (integer)

The ID of the default provisioning template version.

--provisioning-role-arn (string)

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

--pre-provisioning-hook (structure)

Updates the pre-provisioning hook template.

payloadVersion -> (string)

The payload that was sent to the target function.

Note: Only Lambda functions are currently supported.

targetArn -> (string)

The ARN of the target function.

Note: Only Lambda functions are currently supported.

Shorthand Syntax:

payloadVersion=string,targetArn=string

JSON Syntax:

{
  "payloadVersion": "string",
  "targetArn": "string"
}

--remove-pre-provisioning-hook | --no-remove-pre-provisioning-hook (boolean)

Removes pre-provisioning hook template.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To update a provisioning template

The following update-provisioning-template example modifies the description and role arn for the specified provisioning template and enables the template.

aws iot update-provisioning-template \
    --template-name widget-template \
    --enabled \
    --description "An updated provisioning template for widgets" \
    --provisioning-role-arn arn:aws:iam::504350838278:role/Provision_role

This command produces no output.

For more information, see AWS IoT Secure Tunneling in the AWS IoT Core Developer Guide.

Output

None