[ aws . iot ]

describe-provisioning-template

Description

Returns information about a fleet provisioning template.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-provisioning-template
--template-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--template-name (string)

The name of the fleet provisioning 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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

templateArn -> (string)

The ARN of the fleet provisioning template.

templateName -> (string)

The name of the fleet provisioning template.

description -> (string)

The description of the fleet provisioning template.

creationDate -> (timestamp)

The date when the fleet provisioning template was created.

lastModifiedDate -> (timestamp)

The date when the fleet provisioning template was last modified.

defaultVersionId -> (integer)

The default fleet template version ID.

templateBody -> (string)

The JSON formatted contents of the fleet provisioning template.

enabled -> (boolean)

True if the fleet provisioning template is enabled, otherwise false.

provisioningRoleArn -> (string)

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

preProvisioningHook -> (structure)

Gets information about a pre-provisioned hook.

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.