DocumentParameter - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DocumentParameter

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.

Note

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

Contents

description

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

Type: String

Length Constraints: Maximum length of 2028.

Pattern: [^\p{C}]+

Required: No

example

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

Type: String

Pattern: [^\p{C}]+

Required: No

key

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_-]+

Required: No

optional

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

Type: Boolean

Required: No

regex

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: