resolvers_by_functions

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

Overview

Name	resolvers_by_functions
Type	Resource
Id	aws.appsync.resolvers_by_functions

Fields

The following fields are returned by SELECT queries:

list_resolvers_by_function

Name	Datatype	Description
caching_config	object	The caching configuration for a resolver that has caching activated.
code	string	The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
data_source_name	string	The resolver data source name. (pattern: <code>[_A-Za-z][_0-9A-Za-z]*</code>)
field_name	string	The resolver field name. (pattern: <code>[_A-Za-z][_0-9A-Za-z]*</code>)
kind	string	The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources. (UNIT, PIPELINE)
max_batch_size	integer	The maximum batching size for a resolver.
metrics_config	string	Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you can still set its value. metricsConfig can be ENABLED or DISABLED. (ENABLED, DISABLED)
pipeline_config	object	The pipeline configuration for a resolver of kind PIPELINE.
request_mapping_template	string	The request mapping template. (pattern: <code>^.*$</code>)
resolver_arn	string	The resolver Amazon Resource Name (ARN).
response_mapping_template	string	The response mapping template. (pattern: <code>^.*$</code>)
runtime	object	Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
sync_config	object	Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
type_name	string	The resolver type name. (pattern: <code>[_A-Za-z][_0-9A-Za-z]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_resolvers_by_function	select	api_id, function_id, region	nextToken, maxResults	List the resolvers that are associated with a specific function.

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
api_id	string	The API ID.
function_id	string	The function ID.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that you want the request to return.
nextToken	string	An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

SELECT examples

list_resolvers_by_function

List the resolvers that are associated with a specific function.

SELECT
caching_config,
code,
data_source_name,
field_name,
kind,
max_batch_size,
metrics_config,
pipeline_config,
request_mapping_template,
resolver_arn,
response_mapping_template,
runtime,
sync_config,
type_name
FROM aws.appsync.resolvers_by_functions
WHERE api_id = '{{ api_id }}' -- required
AND function_id = '{{ function_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;