field_options

Creates, updates, deletes, gets or lists a field_options resource.

Overview

Name	field_options
Type	Resource
Id	aws.connectcases.field_options

Fields

The following fields are returned by SELECT queries:

list_field_options

Name	Datatype	Description
next_token	string	The token for the next set of results. This is null if there are no more results to return.
options	array	A list of FieldOption objects.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_field_options	select	domain_id, field_id, region	maxResults, nextToken, values	Lists all of the field options for a field identifier in the domain.
batch_put_field_options	exec	domain_id, field_id, region, options		Creates and updates a set of field options for a single select field in a Cases domain.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_id	string	The unique identifier of the Cases domain.
field_id	string	The unique identifier of a field.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
values	array	A list of FieldOption values to filter on for ListFieldOptions.

SELECT examples

list_field_options

Lists all of the field options for a field identifier in the domain.

SELECT
next_token,
options
FROM aws.connectcases.field_options
WHERE domain_id = '{{ domain_id }}' -- required
AND field_id = '{{ field_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND values = '{{ values }}'
;

Lifecycle Methods

batch_put_field_options

Creates and updates a set of field options for a single select field in a Cases domain.

EXEC aws.connectcases.field_options.batch_put_field_options 
@domain_id='{{ domain_id }}' --required, 
@field_id='{{ field_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"options": "{{ options }}"
}'
;