describe-registration-field-definitions¶

Description¶

Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.

Synopsis¶

  describe-registration-field-definitions
--registration-type <value>
[--section-path <value>]
[--field-paths <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--registration-type (string) [required]

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

Constraints:

min: 1

max: 64

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

--section-path (string)

The path to the section of the registration.

Constraints:

min: 1

max: 100

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

--field-paths (list)

An array of paths to the registration form field.

Constraints:

min: 0

max: 5

(string)

Constraints:

min: 1

max: 100

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

Syntax:

"string" "string" ...

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

RegistrationType -> (string)

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

Constraints:

min: 1

max: 64

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

RegistrationFieldDefinitions -> (list)

An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.

(structure)

Provides a description of the specified field.

SectionPath -> (string) [required]

The section path of the field.

Constraints:

min: 1

max: 100

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

FieldPath -> (string) [required]

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

Constraints:

min: 1

max: 100

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

FieldType -> (string) [required]

The type of field.

Possible values:

SELECT

TEXT

ATTACHMENT

FieldRequirement -> (string) [required]

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

Possible values:

REQUIRED

CONDITIONAL

OPTIONAL

SelectValidation -> (structure)

The validation rules for a select field.

MinChoices -> (integer) [required]

The minimum number of choices for the select.

MaxChoices -> (integer) [required]

The maximum number of choices for the select.

Options -> (list) [required]

An array of strings for the possible selection options.

(string)

TextValidation -> (structure)

The validation rules for a text field.

MinLength -> (integer) [required]

The minimum number of characters for the text field.

MaxLength -> (integer) [required]

The maximum number of characters for the text field.

Pattern -> (string) [required]

The regular expression used to validate the text field.

DisplayHints -> (structure) [required]

An array of RegistrationFieldDisplayHints objects for the field.

Title -> (string) [required]

The title of the display hint.

ShortDescription -> (string) [required]

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.

(structure)

A description of each select option.

Option -> (string) [required]

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 -> (structure)

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) [required]

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.

Constraints:

min: 1

max: 20

(structure)

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) [required]

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.

Constraints:

min: 1

max: 5

(structure)

A single condition on a dependency field’s value. Conditions are combined into a ConditionalRule and evaluated together with logical AND.

DependsOnFieldPath -> (string) [required]

The path of the field whose value determines this condition, for example companyInfo.businessType .

Constraints:

min: 1

max: 100

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

Operator -> (string) [required]

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.

Constraints:

min: 1

max: 64

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

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.

Constraints:

min: 0

max: 20

(string)

Constraints:

min: 1

max: 256

RuleBehavior -> (string) [required]

The field behavior that applies when all conditions in this rule match. Valid values are REQUIRED , OPTIONAL , and DISALLOWED .

Constraints:

min: 1

max: 64

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

ConditionalValidation -> (structure)

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.

Constraints:

min: 0

MaxLength -> (integer)

The maximum length for the field value when this rule applies.

Constraints:

min: 0

Pattern -> (string)

A regular expression that the field value must match when this rule applies.

Constraints:

min: 1

max: 2048

AllowedValues -> (list)

The allowed values for a select field when this rule applies. A subset of the field’s full option list.

Constraints:

min: 0

max: 100

(string)

Constraints:

min: 1

max: 256

DefaultBehavior -> (string) [required]

The field behavior that applies when no conditional rule in Rules matches. Valid values are REQUIRED , OPTIONAL , and DISALLOWED .

Constraints:

min: 1

max: 64

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

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.

Constraints:

min: 1

max: 1024

pattern: .+

Table of Contents

Feedback

User Guide