Class: Aws::IoT::Types::DescribeManagedJobTemplateResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::DescribeManagedJobTemplateResponse

Defined in:

gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The unique description of a managed template.

• #document ⇒ String

  The document schema for a managed job template.

• #document_parameters ⇒ Array<Types::DocumentParameter>

  A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.

• #environments ⇒ Array<String>

  A list of environments that are supported with the managed job template.

• #template_arn ⇒ String

  The unique Amazon Resource Name (ARN) of the managed template.

• #template_name ⇒ String

  The unique name of a managed template, such as AWS-Reboot.

• #template_version ⇒ String

  The version for a managed template.

Instance Attribute Details

#description ⇒ String

The unique description of a managed template.

Returns:

• (String)

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

class DescribeManagedJobTemplateResponse < Struct.new(
  :template_name,
  :template_arn,
  :description,
  :template_version,
  :environments,
  :document_parameters,
  :document)
  SENSITIVE = []
  include Aws::Structure
end

#document ⇒ String

The document schema for a managed job template.

Returns:

• (String)

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

class DescribeManagedJobTemplateResponse < Struct.new(
  :template_name,
  :template_arn,
  :description,
  :template_version,
  :environments,
  :document_parameters,
  :document)
  SENSITIVE = []
  include Aws::Structure
end

#document_parameters ⇒ Array<Types::DocumentParameter>

A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

Returns:

• (Array<Types::DocumentParameter>)

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

class DescribeManagedJobTemplateResponse < Struct.new(
  :template_name,
  :template_arn,
  :description,
  :template_version,
  :environments,
  :document_parameters,
  :document)
  SENSITIVE = []
  include Aws::Structure
end

#environments ⇒ Array<String>

A list of environments that are supported with the managed job template.

Returns:

• (Array<String>)

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

class DescribeManagedJobTemplateResponse < Struct.new(
  :template_name,
  :template_arn,
  :description,
  :template_version,
  :environments,
  :document_parameters,
  :document)
  SENSITIVE = []
  include Aws::Structure
end

#template_arn ⇒ String

The unique Amazon Resource Name (ARN) of the managed template.

Returns:

• (String)

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

class DescribeManagedJobTemplateResponse < Struct.new(
  :template_name,
  :template_arn,
  :description,
  :template_version,
  :environments,
  :document_parameters,
  :document)
  SENSITIVE = []
  include Aws::Structure
end

#template_name ⇒ String

The unique name of a managed template, such as AWS-Reboot.

Returns:

• (String)

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

class DescribeManagedJobTemplateResponse < Struct.new(
  :template_name,
  :template_arn,
  :description,
  :template_version,
  :environments,
  :document_parameters,
  :document)
  SENSITIVE = []
  include Aws::Structure
end

#template_version ⇒ String

The version for a managed template.

Returns:

• (String)

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

class DescribeManagedJobTemplateResponse < Struct.new(
  :template_name,
  :template_arn,
  :description,
  :template_version,
  :environments,
  :document_parameters,
  :document)
  SENSITIVE = []
  include Aws::Structure
end