View a markdown version of this page

JobParameter - AWS Deadline Cloud

JobParameter

The details of job parameters.

Contents

Important

This data type is a UNION, so only one of the following members can be specified when used or returned.

bool

A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and 0, case-insensitive.

Type: String

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

Pattern: ([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[Yy][Ee][Ss]|[Nn][Oo]|[Oo][Nn]|[Oo][Ff][Ff]|[01])

Required: No

boolList

A list of boolean values, each represented as a string.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 512 items.

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

Pattern: ([Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|[Yy][Ee][Ss]|[Nn][Oo]|[Oo][Nn]|[Oo][Ff][Ff]|[01])

Required: No

float

A double precision IEEE-754 floating point number represented as a string.

Type: String

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

Pattern: [-]?(0|[1-9][0-9]*)([.][0-9]+)?([eE][+-]?[0-9]+)?

Required: No

floatList

A list of double precision IEEE-754 floating point numbers, each represented as a string.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 512 items.

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

Pattern: [-]?(0|[1-9][0-9]*)([.][0-9]+)?([eE][+-]?[0-9]+)?

Required: No

int

A signed integer represented as a string.

Type: String

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

Pattern: [-]?(0|[1-9][0-9]*)

Required: No

intList

A list of signed integers, each represented as a string.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 512 items.

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

Pattern: [-]?(0|[1-9][0-9]*)

Required: No

intListList

A list of lists of signed integers, each represented as a string.

Type: Array of arrays of strings

Array Members: Minimum number of 0 items. Maximum number of 512 items.

Array Members: Minimum number of 0 items. Maximum number of 64 items.

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

Pattern: [-]?(0|[1-9][0-9]*)

Required: No

path

A file system path represented as a string.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

pathList

A list of file system paths, each represented as a string.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 64 items.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

rangeExpr

An Open Job Description range expression represented as a string, such as 1-10:2.

Type: String

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

Required: No

string

A UTF-8 string.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

stringList

A list of UTF-8 strings.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 64 items.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

See Also

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