Updates the properties of an existing field.
Request Syntax
PUT /domains/domainId/fields/fieldId HTTP/1.1
Content-type: application/json
{
"description": "string",
"name": "string"
}URI Request Parameters
The request uses the following URI parameters.
Request Body
The request accepts the following data in JSON format.
- description
-
The description of a field.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Required: No
- name
-
The name of the field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^.*[\S]$Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
HTTP Status Code: 409
- InternalServerException
-
We couldn't process your request because of an issue with the server. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The rate has been exceeded for this API. Please try again after a few minutes.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. Check the syntax and try again.
HTTP Status Code: 400
Examples
Request and Response example
This example illustrates one usage of UpdateField.
{
"name": "updated_field_name"
} { }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
