Class: Aws::IoT::Types::DescribeProvisioningTemplateResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::DescribeProvisioningTemplateResponse

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_date ⇒ Time

  The date when the provisioning template was created.

• #default_version_id ⇒ Integer

  The default fleet template version ID.

• #description ⇒ String

  The description of the provisioning template.

• #enabled ⇒ Boolean

  True if the provisioning template is enabled, otherwise false.

• #last_modified_date ⇒ Time

  The date when the provisioning template was last modified.

• #pre_provisioning_hook ⇒ Types::ProvisioningHook

  Gets information about a pre-provisioned hook.

• #provisioning_role_arn ⇒ String

  The ARN of the role associated with the provisioning template.

• #template_arn ⇒ String

  The ARN of the provisioning template.

• #template_body ⇒ String

  The JSON formatted contents of the provisioning template.

• #template_name ⇒ String

  The name of the provisioning template.

• #type ⇒ String

  The type you define in a provisioning template.

Instance Attribute Details

#creation_date ⇒ Time

The date when the provisioning template was created.

Returns:

• (Time)

# File 'lib/aws-sdk-iot/types.rb', line 6005

class DescribeProvisioningTemplateResponse < Struct.new(
  :template_arn,
  :template_name,
  :description,
  :creation_date,
  :last_modified_date,
  :default_version_id,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#default_version_id ⇒ Integer

The default fleet template version ID.

Returns:

• (Integer)

# File 'lib/aws-sdk-iot/types.rb', line 6005

class DescribeProvisioningTemplateResponse < Struct.new(
  :template_arn,
  :template_name,
  :description,
  :creation_date,
  :last_modified_date,
  :default_version_id,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the provisioning template.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 6005

class DescribeProvisioningTemplateResponse < Struct.new(
  :template_arn,
  :template_name,
  :description,
  :creation_date,
  :last_modified_date,
  :default_version_id,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

True if the provisioning template is enabled, otherwise false.

Returns:

• (Boolean)

# File 'lib/aws-sdk-iot/types.rb', line 6005

class DescribeProvisioningTemplateResponse < Struct.new(
  :template_arn,
  :template_name,
  :description,
  :creation_date,
  :last_modified_date,
  :default_version_id,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Time

The date when the provisioning template was last modified.

Returns:

• (Time)

# File 'lib/aws-sdk-iot/types.rb', line 6005

class DescribeProvisioningTemplateResponse < Struct.new(
  :template_arn,
  :template_name,
  :description,
  :creation_date,
  :last_modified_date,
  :default_version_id,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#pre_provisioning_hook ⇒ Types::ProvisioningHook

Gets information about a pre-provisioned hook.

Returns:

• (Types::ProvisioningHook)

# File 'lib/aws-sdk-iot/types.rb', line 6005

class DescribeProvisioningTemplateResponse < Struct.new(
  :template_arn,
  :template_name,
  :description,
  :creation_date,
  :last_modified_date,
  :default_version_id,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#provisioning_role_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 6005

class DescribeProvisioningTemplateResponse < Struct.new(
  :template_arn,
  :template_name,
  :description,
  :creation_date,
  :last_modified_date,
  :default_version_id,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#template_arn ⇒ String

The ARN of the provisioning template.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 6005

class DescribeProvisioningTemplateResponse < Struct.new(
  :template_arn,
  :template_name,
  :description,
  :creation_date,
  :last_modified_date,
  :default_version_id,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#template_body ⇒ String

The JSON formatted contents of the provisioning template.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 6005

class DescribeProvisioningTemplateResponse < Struct.new(
  :template_arn,
  :template_name,
  :description,
  :creation_date,
  :last_modified_date,
  :default_version_id,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#template_name ⇒ String

The name of the provisioning template.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 6005

class DescribeProvisioningTemplateResponse < Struct.new(
  :template_arn,
  :template_name,
  :description,
  :creation_date,
  :last_modified_date,
  :default_version_id,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/iot/latest/developerguide/provision-template.html

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 6005

class DescribeProvisioningTemplateResponse < Struct.new(
  :template_arn,
  :template_name,
  :description,
  :creation_date,
  :last_modified_date,
  :default_version_id,
  :template_body,
  :enabled,
  :provisioning_role_arn,
  :pre_provisioning_hook,
  :type)
  SENSITIVE = []
  include Aws::Structure
end