View Source AWS.AppSync (aws-elixir v1.0.0)

AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.

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 a cache for the GraphQL API.

Creates a unique key that you can distribute to clients who invoke your API.

Creates a custom DomainName 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.

Retrieves an ApiAssociation object.

Retrieves an ApiCache object.

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 current status of a schema creation operation.

Creates a list of environmental variables in an API by its ID value.

Adds a new schema to your GraphQL API.

Tags a resource with user-supplied tags.

Updates the cache for the GraphQL API.

Updates some of the configuration choices of a particular source API association.

Functions

Link to this function

associate_api(client, domain_name, input, options \\ [])

View Source

Maps an endpoint to your custom domain.

Link to this function

associate_merged_graphql_api(client, source_api_identifier, input, options \\ [])

View Source

Creates an association between a Merged API and source API using the source API's identifier.

Link to this function

associate_source_graphql_api(client, merged_api_identifier, input, options \\ [])

View Source

Creates an association between a Merged API and source API using the Merged API's identifier.

Link to this function

create_api_cache(client, api_id, input, options \\ [])

View Source

Creates a cache for the GraphQL API.

Link to this function

create_api_key(client, api_id, input, options \\ [])

View Source

Creates a unique key that you can distribute to clients who invoke your API.

Link to this function

create_data_source(client, api_id, input, options \\ [])

View Source

Creates a DataSource object.

Link to this function

create_domain_name(client, input, options \\ [])

View Source

Creates a custom DomainName object.

Link to this function

create_function(client, api_id, input, options \\ [])

View Source

Creates a Function object.

A function is a reusable entity. You can use multiple functions to compose the resolver logic.

Link to this function

create_graphql_api(client, input, options \\ [])

View Source

Creates a GraphqlApi object.

Link to this function

create_resolver(client, api_id, type_name, input, options \\ [])

View Source

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.

Link to this function

create_type(client, api_id, input, options \\ [])

View Source

Creates a Type object.

Link to this function

delete_api_cache(client, api_id, input, options \\ [])

View Source

Deletes an ApiCache object.

Link to this function

delete_api_key(client, api_id, id, input, options \\ [])

View Source

Deletes an API key.

Link to this function

delete_data_source(client, api_id, name, input, options \\ [])

View Source

Deletes a DataSource object.

Link to this function

delete_domain_name(client, domain_name, input, options \\ [])

View Source

Deletes a custom DomainName object.

Link to this function

delete_function(client, api_id, function_id, input, options \\ [])

View Source

Deletes a Function.

Link to this function

delete_graphql_api(client, api_id, input, options \\ [])

View Source

Deletes a GraphqlApi object.

Link to this function

delete_resolver(client, api_id, field_name, type_name, input, options \\ [])

View Source

Deletes a Resolver object.

Link to this function

delete_type(client, api_id, type_name, input, options \\ [])

View Source

Deletes a Type object.

Link to this function

disassociate_api(client, domain_name, input, options \\ [])

View Source

Removes an ApiAssociation object from a custom domain.

Link to this function

disassociate_merged_graphql_api(client, association_id, source_api_identifier, input, options \\ [])

View Source

Deletes an association between a Merged API and source API using the source API's identifier and the association ID.

Link to this function

disassociate_source_graphql_api(client, association_id, merged_api_identifier, input, options \\ [])

View Source

Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.

Link to this function

evaluate_code(client, input, options \\ [])

View Source

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.

Link to this function

evaluate_mapping_template(client, input, options \\ [])

View Source

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).

Link to this function

flush_api_cache(client, api_id, input, options \\ [])

View Source

Flushes an ApiCache object.

Link to this function

get_api_association(client, domain_name, options \\ [])

View Source

Retrieves an ApiAssociation object.

Link to this function

get_api_cache(client, api_id, options \\ [])

View Source

Retrieves an ApiCache object.

Link to this function

get_data_source(client, api_id, name, options \\ [])

View Source

Retrieves a DataSource object.

Link to this function

get_data_source_introspection(client, introspection_id, include_models_s_d_l \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves 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.

Link to this function

get_domain_name(client, domain_name, options \\ [])

View Source

Retrieves a custom DomainName object.

Link to this function

get_function(client, api_id, function_id, options \\ [])

View Source

Get a Function.

Link to this function

get_graphql_api(client, api_id, options \\ [])

View Source

Retrieves a GraphqlApi object.

Link to this function

get_graphql_api_environment_variables(client, api_id, options \\ [])

View Source

Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.

Link to this function

get_introspection_schema(client, api_id, format, include_directives \\ nil, options \\ [])

View Source

Retrieves the introspection schema for a GraphQL API.

Link to this function

get_resolver(client, api_id, field_name, type_name, options \\ [])

View Source

Retrieves a Resolver object.

Link to this function

get_schema_creation_status(client, api_id, options \\ [])

View Source

Retrieves the current status of a schema creation operation.

Link to this function

get_source_api_association(client, association_id, merged_api_identifier, options \\ [])

View Source

Retrieves a SourceApiAssociation object.

Link to this function

get_type(client, api_id, type_name, format, options \\ [])

View Source

Retrieves a Type object.

Link to this function

list_api_keys(client, api_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists 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.

Link to this function

list_data_sources(client, api_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the data sources for a given API.

Link to this function

list_domain_names(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists multiple custom domain names.

Link to this function

list_functions(client, api_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List multiple functions.

Link to this function

list_graphql_apis(client, api_type \\ nil, max_results \\ nil, next_token \\ nil, owner \\ nil, options \\ [])

View Source

Lists your GraphQL APIs.

Link to this function

list_resolvers(client, api_id, type_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the resolvers for a given API and type.

Link to this function

list_resolvers_by_function(client, api_id, function_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List the resolvers that are associated with a specific function.

Link to this function

list_source_api_associations(client, api_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the SourceApiAssociationSummary data.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags for a resource.

Link to this function

list_types(client, api_id, format, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the types for a given API.

Link to this function

list_types_by_association(client, association_id, merged_api_identifier, format, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists Type objects by the source API association ID.

Link to this function

put_graphql_api_environment_variables(client, api_id, input, options \\ [])

View Source

Creates 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.

Link to this function

start_data_source_introspection(client, input, options \\ [])

View Source

Creates a new introspection.

Returns the introspectionId of the new introspection after its creation.

Link to this function

start_schema_creation(client, api_id, input, options \\ [])

View Source

Adds a new schema to your GraphQL API.

This operation is asynchronous. Use to determine when it has completed.

Link to this function

start_schema_merge(client, association_id, merged_api_identifier, input, options \\ [])

View Source

Initiates a merge operation.

Returns a status that shows the result of the merge operation.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Tags a resource with user-supplied tags.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Untags a resource.

Link to this function

update_api_cache(client, api_id, input, options \\ [])

View Source

Updates the cache for the GraphQL API.

Link to this function

update_api_key(client, api_id, id, input, options \\ [])

View Source

Updates an API key.

You can update the key as long as it's not deleted.

Link to this function

update_data_source(client, api_id, name, input, options \\ [])

View Source

Updates a DataSource object.

Link to this function

update_domain_name(client, domain_name, input, options \\ [])

View Source

Updates a custom DomainName object.

Link to this function

update_function(client, api_id, function_id, input, options \\ [])

View Source

Updates a Function object.

Link to this function

update_graphql_api(client, api_id, input, options \\ [])

View Source

Updates a GraphqlApi object.

Link to this function

update_resolver(client, api_id, field_name, type_name, input, options \\ [])

View Source

Updates a Resolver object.

Link to this function

update_source_api_association(client, association_id, merged_api_identifier, input, options \\ [])

View Source

Updates some of the configuration choices of a particular source API association.

Link to this function

update_type(client, api_id, type_name, input, options \\ [])

View Source

Updates a Type object.