AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

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.

Inheritance Hierarchy

System.Object
  Amazon.IoT.Model.DocumentParameter

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C#
public class DocumentParameter

The DocumentParameter type exposes the following members

Constructors

NameDescription
Public Method DocumentParameter()

Properties

NameTypeDescription
Public Property Description System.String

Gets and sets the property Description.

Description of the map field containing the patterns that need to be replaced in a managed template job document schema.

Public Property Example System.String

Gets and sets the property Example.

An example illustrating a pattern that need to be replaced in a managed template job document schema.

Public Property Key System.String

Gets and sets the property Key.

Key of the map field containing the patterns that need to be replaced in a managed template job document schema.

Public Property Optional System.Boolean

Gets and sets the property Optional.

Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.

Public Property Regex System.String

Gets and sets the property Regex.

A regular expression of the patterns that need to be replaced in a managed template job document schema.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5