DescribeRegistrationFieldValues
Retrieves the specified registration field values.
Request Syntax
{
"FieldPaths": [ "string" ],
"MaxResults": number,
"NextToken": "string",
"RegistrationId": "string",
"SectionPath": "string",
"VersionNumber": number
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- FieldPaths
-
An array of paths to the registration form field.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9_\.]+Required: No
- MaxResults
-
The maximum number of results to return per each request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.+Required: No
- RegistrationId
-
The unique identifier for the registration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9_:/-]+Required: Yes
- SectionPath
-
The path to the section of the registration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9_]+Required: No
- VersionNumber
-
The version number of the registration.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 100000.
Required: No
Response Syntax
{
"NextToken": "string",
"RegistrationArn": "string",
"RegistrationFieldValues": [
{
"DeniedReason": "string",
"FieldPath": "string",
"RegistrationAttachmentId": "string",
"SelectChoices": [ "string" ],
"TextValue": "string"
}
],
"RegistrationId": "string",
"VersionNumber": number
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.+ - RegistrationArn
-
The Amazon Resource Name (ARN) for the registration.
Type: String
- RegistrationFieldValues
-
An array of RegistrationFieldValues objects that contain the values for the requested registration.
Type: Array of RegistrationFieldValueInformation objects
- RegistrationId
-
The unique identifier for the registration.
Type: String
- VersionNumber
-
The current version of the registration.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 100000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because you don't have sufficient permissions to access the resource.
HTTP Status Code: 400
- InternalServerException
-
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
HTTP Status Code: 500
- ResourceNotFoundException
-
A requested resource couldn't be found.
HTTP Status Code: 400
- ThrottlingException
-
An error that occurred because too many requests were sent during a certain amount of time.
HTTP Status Code: 400
- ValidationException
-
A validation exception for a field.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
