View Source AWS.AppSync (aws-elixir v1.0.4)
AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
Link to this section Summary
Functions
Maps an endpoint to your custom domain.
Creates an association between a Merged API and source API using the source API's identifier.
Creates an association between a Merged API and source API using the Merged API's identifier.
Creates an Api
object.
Creates a cache for the GraphQL API.
Creates a unique key that you can distribute to clients who invoke your API.
Creates a ChannelNamespace
for an Api
.
Creates a DataSource
object.
Creates a custom DomainName
object.
Creates a Function
object.
Creates a GraphqlApi
object.
Creates a Resolver
object.
Creates a Type
object.
Deletes an Api
object
Deletes an ApiCache
object.
Deletes an API key.
Deletes a ChannelNamespace
.
Deletes a DataSource
object.
Deletes a custom DomainName
object.
Deletes a GraphqlApi
object.
Deletes a Resolver
object.
Deletes a Type
object.
Removes an ApiAssociation
object from a custom domain.
Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
Evaluates the given code and returns the response.
Evaluates a given template and returns the response.
Flushes an ApiCache
object.
Retrieves an Api
object.
Retrieves an ApiAssociation
object.
Retrieves an ApiCache
object.
Retrieves the channel namespace for a specified Api
.
Retrieves a DataSource
object.
Retrieves the record of an existing introspection.
Retrieves a custom DomainName
object.
Retrieves a GraphqlApi
object.
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
Retrieves the introspection schema for a GraphQL API.
Retrieves a Resolver
object.
Retrieves the current status of a schema creation operation.
Retrieves a SourceApiAssociation
object.
Retrieves a Type
object.
Lists the API keys for a given API.
Lists the APIs in your AppSync account.
Lists the channel namespaces for a specified Api
.
Lists the data sources for a given API.
Lists multiple custom domain names.
List multiple functions.
Lists your GraphQL APIs.
Lists the resolvers for a given API and type.
List the resolvers that are associated with a specific function.
Lists the SourceApiAssociationSummary
data.
Lists the tags for a resource.
Lists the types for a given API.
Lists Type
objects by the source API association ID.
Creates a list of environmental variables in an API by its ID value.
Creates a new introspection.
Adds a new schema to your GraphQL API.
Initiates a merge operation.
Tags a resource with user-supplied tags.
Untags a resource.
Updates an Api
.
Updates the cache for the GraphQL API.
Updates an API key.
Updates a ChannelNamespace
associated with an Api
.
Updates a DataSource
object.
Updates a custom DomainName
object.
Updates a Function
object.
Updates a GraphqlApi
object.
Updates a Resolver
object.
Updates some of the configuration choices of a particular source API association.
Updates a Type
object.
Link to this section Functions
Maps an endpoint to your custom domain.
associate_merged_graphql_api(client, source_api_identifier, input, options \\ [])
View SourceCreates an association between a Merged API and source API using the source API's identifier.
associate_source_graphql_api(client, merged_api_identifier, input, options \\ [])
View SourceCreates an association between a Merged API and source API using the Merged API's identifier.
Creates an Api
object.
Use this operation to create an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.
Creates a cache for the GraphQL API.
Creates a unique key that you can distribute to clients who invoke your API.
Creates a ChannelNamespace
for an Api
.
Creates a DataSource
object.
Creates a custom DomainName
object.
Creates a Function
object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
Creates a GraphqlApi
object.
Creates a Resolver
object.
A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL.
Creates a Type
object.
Deletes an Api
object
Deletes an ApiCache
object.
Deletes an API key.
delete_channel_namespace(client, api_id, name, input, options \\ [])
View SourceDeletes a ChannelNamespace
.
Deletes a DataSource
object.
Deletes a custom DomainName
object.
delete_function(client, api_id, function_id, input, options \\ [])
View SourceDeletes a Function
.
Deletes a GraphqlApi
object.
delete_resolver(client, api_id, field_name, type_name, input, options \\ [])
View SourceDeletes a Resolver
object.
Deletes a Type
object.
Removes an ApiAssociation
object from a custom domain.
disassociate_merged_graphql_api(client, association_id, source_api_identifier, input, options \\ [])
View SourceDeletes an association between a Merged API and source API using the source API's identifier and the association ID.
disassociate_source_graphql_api(client, association_id, merged_api_identifier, input, options \\ [])
View SourceDeletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
Evaluates the given code and returns the response.
The code definition requirements
depend on the specified runtime. For APPSYNC_JS
runtimes, the code defines the
request and response functions. The request function takes the incoming request
after a
GraphQL operation is parsed and converts it into a request configuration for the
selected
data source operation. The response function interprets responses from the data
source and
maps it to the shape of the GraphQL field output type.
Evaluates a given template and returns the response.
The mapping template can be a request or response template.
Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type.
Mapping templates are written in the Apache Velocity Template Language (VTL).
Flushes an ApiCache
object.
Retrieves an Api
object.
Retrieves an ApiAssociation
object.
Retrieves an ApiCache
object.
Retrieves the channel namespace for a specified Api
.
Retrieves a DataSource
object.
get_data_source_introspection(client, introspection_id, include_models_s_d_l \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves the record of an existing introspection.
If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.
Retrieves a custom DomainName
object.
Get a Function
.
Retrieves a GraphqlApi
object.
get_graphql_api_environment_variables(client, api_id, options \\ [])
View SourceRetrieves the list of environmental variable key-value pairs associated with an API by its ID value.
get_introspection_schema(client, api_id, format, include_directives \\ nil, options \\ [])
View SourceRetrieves the introspection schema for a GraphQL API.
get_resolver(client, api_id, field_name, type_name, options \\ [])
View SourceRetrieves a Resolver
object.
Retrieves the current status of a schema creation operation.
get_source_api_association(client, association_id, merged_api_identifier, options \\ [])
View SourceRetrieves a SourceApiAssociation
object.
Retrieves a Type
object.
list_api_keys(client, api_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the API keys for a given API.
API keys are deleted automatically 60 days after they expire. However, they may
still
be included in the response until they have actually been deleted. You can
safely call
DeleteApiKey
to manually delete a key before it's automatically
deleted.
list_apis(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the APIs in your AppSync account.
ListApis
returns only the high level API details. For more detailed
information about an API, use GetApi
.
list_channel_namespaces(client, api_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the channel namespaces for a specified Api
.
ListChannelNamespaces
returns only high level details for the channel
namespace. To retrieve code handlers, use
GetChannelNamespace
.
list_data_sources(client, api_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the data sources for a given API.
list_domain_names(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists multiple custom domain names.
list_functions(client, api_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList multiple functions.
list_graphql_apis(client, api_type \\ nil, max_results \\ nil, next_token \\ nil, owner \\ nil, options \\ [])
View SourceLists your GraphQL APIs.
list_resolvers(client, api_id, type_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the resolvers for a given API and type.
list_resolvers_by_function(client, api_id, function_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList the resolvers that are associated with a specific function.
list_source_api_associations(client, api_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the SourceApiAssociationSummary
data.
Lists the tags for a resource.
list_types(client, api_id, format, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the types for a given API.
list_types_by_association(client, association_id, merged_api_identifier, format, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists Type
objects by the source API association ID.
put_graphql_api_environment_variables(client, api_id, input, options \\ [])
View SourceCreates a list of environmental variables in an API by its ID value.
When creating an environmental variable, it must follow the constraints below:
* Both JavaScript and VTL templates support environmental variables.
* Environmental variables are not evaluated before function invocation.
* Environmental variables only support string values.
* Any defined value in an environmental variable is considered a string literal and not expanded.
* Variable evaluations should ideally be performed in the function code.
When creating an environmental variable key-value pair, it must follow the additional constraints below:
* Keys must begin with a letter.
* Keys must be at least two characters long.
* Keys can only contain letters, numbers, and the underscore character (_).
* Values can be up to 512 characters long.
* You can configure up to 50 key-value pairs in a GraphQL API.
You can create a list of environmental variables by adding it to the
environmentVariables
payload as a list in the format
{"key1":"value1","key2":"value2", …}
. Note that each call of the
PutGraphqlApiEnvironmentVariables
action will result in the overwriting of
the existing environmental variable list of that API. This means the existing
environmental
variables will be lost. To avoid this, you must include all existing and new
environmental
variables in the list each time you call this action.
Creates a new introspection.
Returns the introspectionId
of the new
introspection after its creation.
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
start_schema_merge(client, association_id, merged_api_identifier, input, options \\ [])
View SourceInitiates a merge operation.
Returns a status that shows the result of the merge operation.
Tags a resource with user-supplied tags.
Untags a resource.
Updates an Api
.
Updates the cache for the GraphQL API.
Updates an API key.
You can update the key as long as it's not deleted.
update_channel_namespace(client, api_id, name, input, options \\ [])
View SourceUpdates a ChannelNamespace
associated with an Api
.
Updates a DataSource
object.
Updates a custom DomainName
object.
update_function(client, api_id, function_id, input, options \\ [])
View SourceUpdates a Function
object.
Updates a GraphqlApi
object.
update_resolver(client, api_id, field_name, type_name, input, options \\ [])
View SourceUpdates a Resolver
object.
update_source_api_association(client, association_id, merged_api_identifier, input, options \\ [])
View SourceUpdates some of the configuration choices of a particular source API association.
Updates a Type
object.