describe_provisioning_template

describe_provisioning_template(**kwargs)

Returns information about a provisioning template.

Requires permission to access the DescribeProvisioningTemplate action.

See also: AWS API Documentation

Request Syntax

response = client.describe_provisioning_template(
    templateName='string'
)

Parameters

templateName (string) --

[REQUIRED]

The name of the provisioning template.

Return type

dict

Returns

Response Syntax

{
    'templateArn': 'string',
    'templateName': 'string',
    'description': 'string',
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1),
    'defaultVersionId': 123,
    'templateBody': 'string',
    'enabled': True|False,
    'provisioningRoleArn': 'string',
    'preProvisioningHook': {
        'payloadVersion': 'string',
        'targetArn': 'string'
    },
    'type': 'FLEET_PROVISIONING'|'JITP'
}

Response Structure

• (dict) --
  • templateArn (string) --

    The ARN of the provisioning template.

  • templateName (string) --

    The name of the provisioning template.

  • description (string) --

    The description of the provisioning template.

  • creationDate (datetime) --

    The date when the provisioning template was created.

  • lastModifiedDate (datetime) --

    The date when the provisioning template was last modified.

  • defaultVersionId (integer) --

    The default fleet template version ID.

  • templateBody (string) --

    The JSON formatted contents of the provisioning template.

  • enabled (boolean) --

    True if the 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 (dict) --

    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.

  • type (string) --

    The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING . For more information about provisioning template, see: Provisioning template.

Exceptions

• IoT.Client.exceptions.InternalFailureException
• IoT.Client.exceptions.InvalidRequestException
• IoT.Client.exceptions.ResourceNotFoundException
• IoT.Client.exceptions.ThrottlingException
• IoT.Client.exceptions.UnauthorizedException