RegistrationFieldDefinition - Amazon Pinpoint SMS and Voice v2 API

RegistrationFieldDefinition

Provides a description of the specified field.

Contents

DisplayHints

An array of RegistrationFieldDisplayHints objects for the field.

Type: RegistrationFieldDisplayHints object

Required: Yes

FieldPath

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

Type: String

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

Pattern: [A-Za-z0-9_\.]+

Required: Yes

FieldRequirement

Specifies if the field for the registration form is required, conditional or optional.

Type: String

Valid Values: REQUIRED | CONDITIONAL | OPTIONAL

Required: Yes

FieldType

The type of field.

Type: String

Valid Values: SELECT | TEXT | ATTACHMENT

Required: Yes

SectionPath

The section path of the field.

Type: String

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

Pattern: [A-Za-z0-9_]+

Required: Yes

SelectValidation

The validation rules for a select field.

Type: SelectValidation object

Required: No

TextValidation

The validation rules for a text field.

Type: TextValidation object

Required: No

See Also

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