DeleteRegistrationFieldValue
Delete the value in a registration form field.
Request Syntax
{
"FieldPath": "string",
"RegistrationId": "string"
}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.
- 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
- 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
Response Syntax
{
"FieldPath": "string",
"RegistrationArn": "string",
"RegistrationAttachmentId": "string",
"RegistrationId": "string",
"SelectChoices": [ "string" ],
"TextValue": "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.
- FieldPath
-
The path to the registration form field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9_\.]+ - RegistrationArn
-
The Amazon Resource Name (ARN) for the registration.
Type: String
- RegistrationAttachmentId
-
The unique identifier for the registration attachment.
Type: String
- RegistrationId
-
The unique identifier for the registration.
Type: String
- SelectChoices
-
An array of values for the form field.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
- TextValue
-
The text data for a free form field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- VersionNumber
-
The version number 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
- ConflictException
-
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of 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:
