2026/08/31 - Amazon Pinpoint SMS Voice V2 - 1 updated api methods
Changes AWS End User Messaging SMS now returns ConditionalBehavior on DescribeRegistrationFieldDefinitions, allowing you to programmatically discover which registration fields are required, optional, or disallowed based on the values of other fields in the same form.
{'RegistrationFieldDefinitions': {'ConditionalBehavior': {'DefaultBehavior': 'string',
'Rules': [{'ConditionalValidation': {'AllowedValues': ['string'],
'MaxLength': 'integer',
'MinLength': 'integer',
'Pattern': 'string'},
'Conditions': [{'DependsOnFieldPath': 'string',
'Operator': 'string',
'Values': ['string']}],
'RuleBehavior': 'string'}]}}}
Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.
See also: AWS API Documentation
Request Syntax
client.describe_registration_field_definitions(
RegistrationType='string',
SectionPath='string',
FieldPaths=[
'string',
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
string
The path to the section of the registration.
list
An array of paths to the registration form field.
(string) --
string
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
integer
The maximum number of results to return per each request.
dict
Response Syntax
{
'RegistrationType': 'string',
'RegistrationFieldDefinitions': [
{
'SectionPath': 'string',
'FieldPath': 'string',
'FieldType': 'SELECT'|'TEXT'|'ATTACHMENT',
'FieldRequirement': 'REQUIRED'|'CONDITIONAL'|'OPTIONAL',
'SelectValidation': {
'MinChoices': 123,
'MaxChoices': 123,
'Options': [
'string',
]
},
'TextValidation': {
'MinLength': 123,
'MaxLength': 123,
'Pattern': 'string'
},
'DisplayHints': {
'Title': 'string',
'ShortDescription': 'string',
'LongDescription': 'string',
'DocumentationTitle': 'string',
'DocumentationLink': 'string',
'SelectOptionDescriptions': [
{
'Option': 'string',
'Title': 'string',
'Description': 'string'
},
],
'TextValidationDescription': 'string',
'ExampleTextValue': 'string'
},
'ConditionalBehavior': {
'Rules': [
{
'Conditions': [
{
'DependsOnFieldPath': 'string',
'Operator': 'string',
'Values': [
'string',
]
},
],
'RuleBehavior': 'string',
'ConditionalValidation': {
'MinLength': 123,
'MaxLength': 123,
'Pattern': 'string',
'AllowedValues': [
'string',
]
}
},
],
'DefaultBehavior': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RegistrationType (string) --
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
RegistrationFieldDefinitions (list) --
An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.
(dict) --
Provides a description of the specified field.
SectionPath (string) --
The section path of the field.
FieldPath (string) --
The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
FieldType (string) --
The type of field.
FieldRequirement (string) --
Specifies if the field for the registration form is required, conditional or optional.
SelectValidation (dict) --
The validation rules for a select field.
MinChoices (integer) --
The minimum number of choices for the select.
MaxChoices (integer) --
The maximum number of choices for the select.
Options (list) --
An array of strings for the possible selection options.
(string) --
TextValidation (dict) --
The validation rules for a text field.
MinLength (integer) --
The minimum number of characters for the text field.
MaxLength (integer) --
The maximum number of characters for the text field.
Pattern (string) --
The regular expression used to validate the text field.
DisplayHints (dict) --
An array of RegistrationFieldDisplayHints objects for the field.
Title (string) --
The title of the display hint.
ShortDescription (string) --
A short description of the display hint.
LongDescription (string) --
A full description of the display hint.
DocumentationTitle (string) --
The title of the document the display hint is associated with.
DocumentationLink (string) --
The link to the document the display hint is associated with.
SelectOptionDescriptions (list) --
An array of SelectOptionDescription objects.
(dict) --
A description of each select option.
Option (string) --
The value of the option.
Title (string) --
The title of the select option.
Description (string) --
A description of the option meaning.
TextValidationDescription (string) --
The validation rules for the text field.
ExampleTextValue (string) --
Example text of what the value of a field should contain.
ConditionalBehavior (dict) --
The conditional behavior rules for this field. Only present when FieldRequirement is CONDITIONAL. Rules are evaluated in order and the first matching rule determines the field's resolved requirement. If no rule matches, the DefaultBehavior applies.
Rules (list) --
An ordered list of conditional rules. Rules are evaluated top-to-bottom and the first rule whose conditions all evaluate to true determines the field's behavior. Rules whose conditions do not all match are skipped and evaluation continues to the next rule.
(dict) --
A single conditional rule that resolves to a field behavior when all of its conditions evaluate to true. Conditions within a rule are combined with logical AND: all conditions must match for the rule to fire.
Conditions (list) --
The conditions that must all evaluate to true for this rule to match. Conditions are combined with logical AND. Use multiple rules with the same RuleBehavior to express logical OR.
(dict) --
A single condition on a dependency field's value. Conditions are combined into a ConditionalRule and evaluated together with logical AND.
DependsOnFieldPath (string) --
The path of the field whose value determines this condition, for example companyInfo.businessType.
Operator (string) --
The comparison operator to apply between the dependency field's value and Values. Valid values are EQUALS, NOT_EQUALS, IN, NOT_IN, HAS_VALUE, and NO_VALUE. Operators not in this list are treated as evaluating to false, which causes the containing rule to be skipped. This allows forward-compatible additions of new operators without breaking older SDK clients.
Values (list) --
The values to compare the dependency field's value against. Required for the EQUALS, NOT_EQUALS, IN, and NOT_IN operators. Omitted for HAS_VALUE and NO_VALUE, which test only presence.
(string) --
RuleBehavior (string) --
The field behavior that applies when all conditions in this rule match. Valid values are REQUIRED, OPTIONAL, and DISALLOWED.
ConditionalValidation (dict) --
Optional per-rule validation constraints (minimum length, maximum length, regex pattern, allowed select values) that override the field's default validation when this rule matches.
MinLength (integer) --
The minimum length for the field value when this rule applies.
MaxLength (integer) --
The maximum length for the field value when this rule applies.
Pattern (string) --
A regular expression that the field value must match when this rule applies.
AllowedValues (list) --
The allowed values for a select field when this rule applies. A subset of the field's full option list.
(string) --
DefaultBehavior (string) --
The field behavior that applies when no conditional rule in Rules matches. Valid values are REQUIRED, OPTIONAL, and DISALLOWED.
NextToken (string) --
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.