BatchPutFieldOptions
Creates and updates a set of field options for a single select field in a Cases domain.
Request Syntax
PUT /domains/domainId
/fields/fieldId
/options HTTP/1.1
Content-type: application/json
{
"options": [
{
"active": boolean
,
"name": "string
",
"value": "string
"
}
]
}
URI Request Parameters
The request uses the following URI parameters.
Request Body
The request accepts the following data in JSON format.
- options
-
A list of
FieldOption
objects.Type: Array of FieldOption objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"errors": [
{
"errorCode": "string",
"message": "string",
"value": "string"
}
]
}
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.
- errors
-
A list of field errors.
Type: Array of FieldOptionError objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
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
- 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
- ServiceQuotaExceededException
-
The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
HTTP Status Code: 402
- 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
Example
Request and Response Example:
{
"options": [
{
"active": true,
"name": "California",
"value": "CA"
},
{
"active": true,
"name": "Washington",
"value": "WA"
},
{
"active": false,
"name": "New York",
"value": "NY"
},
{
"active": false,
"name": "Massachusetts",
"value": "MA"
}
]
}
{
"errors": []
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: