list-provisioning-templates¶

Description¶

Lists the fleet provisioning templates in your AWS account.

Synopsis¶

  list-provisioning-templates
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--max-results (integer)

The maximum number of results to return at one time.

--next-token (string)

A token to retrieve the next set of results.

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

Examples¶

To list provisioning templates

The following list-provisioning-templates example lists all of the provisioning templates in your AWS account.

aws iot list-provisioning-templates

Output:

{
    "templates": [
        {
            "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template",
            "templateName": "widget-template",
            "description": "A provisioning template for widgets",
            "creationDate": 1574800471.367,
            "lastModifiedDate": 1574801192.324,
            "enabled": false
        }
    ]
}

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

Output¶

templates -> (list)

A list of fleet provisioning templates

(structure)

A summary of information about a fleet provisioning template.

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 summary was created.

lastModifiedDate -> (timestamp)

The date when the fleet provisioning template summary was last modified.

enabled -> (boolean)

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

nextToken -> (string)