[ aws . iot ]

describe-provisioning-template

Description

Returns information about a fleet provisioning template.

Requires permission to access the DescribeProvisioningTemplate action.

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

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.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe a provisioning template

The following describe-provisioning-template example describes a provisioning template.

aws iot describe-provisioning-template \
    --template-name MyTestProvisioningTemplate

Output:

{
    "templateArn": "arn:aws:iot:us-west-2:57EXAMPLE833:provisioningtemplate/MyTestProvisioningTemplate",
    "templateName": "MyTestProvisioningTemplate",
    "creationDate": 1589308310.574,
    "lastModifiedDate": 1589308345.539,
    "defaultVersionId": 1,
    "templateBody": "{
        \"Parameters\":{
            \"SerialNumber\":{
                \"Type\":\"String\"
            },
            \"AWS::IoT::Certificate::Id\":{
                \"Type\":\"String\"
            }
        },
        \"Resources\":{
            \"certificate\":{
                \"Properties\":{
                    \"CertificateId\":{
                        \"Ref\":\"AWS::IoT::Certificate::Id\"
                    },
                    \"Status\":\"Active\"
                },
                \"Type\":\"AWS::IoT::Certificate\"
            },
            \"policy\":{
                \"Properties\":{
                    \"PolicyName\":\"MyIotPolicy\"
                },
                \"Type\":\"AWS::IoT::Policy\"
            },
            \"thing\":{
                \"OverrideSettings\":{
                    \"AttributePayload\":\"MERGE\",
                    \"ThingGroups\":\"DO_NOTHING\",
                    \"ThingTypeName\":\"REPLACE\"
                },
                \"Properties\":{
                    \"AttributePayload\":{},
                    \"ThingGroups\":[],
                    \"ThingName\":{
                        \"Fn::Join\":[
                            \"\",
                            [
                                \"DemoGroup_\",
                                {\"Ref\":\"SerialNumber\"}
                            ]
                        ]
                    },
                    \"ThingTypeName\":\"VirtualThings\"
                },
                \"Type\":\"AWS::IoT::Thing\"
            }
        }
    }",
    "enabled": true,
    "provisioningRoleArn": "arn:aws:iam::571032923833:role/service-role/IoT_access"
}

For more information, see Provisioning devices that don’t have device certificates using fleet provisioning in the AWS IoT Core Developers Guide.

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.