View Source aws_appsync (aws v1.0.4)

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

Creates a Function object.

Creates a GraphqlApi object.
Creates a Type object.
Deletes an ApiCache object.
Deletes a DataSource object.
Deletes a custom DomainName object.
Deletes a GraphqlApi 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 ApiAssociation object.
Retrieves an ApiCache object.
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 the current status of a schema creation operation.

Lists the API keys for a given 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.

Tags a resource with user-supplied tags.
Updates the cache for the GraphQL API.
Updates a DataSource object.
Updates a custom DomainName object.
Updates a GraphqlApi object.
Updates some of the configuration choices of a particular source API association.

Functions

Link to this function

associate_api(Client, DomainName, Input)

View Source
Maps an endpoint to your custom domain.
Link to this function

associate_api(Client, DomainName, Input0, Options0)

View Source
Link to this function

associate_merged_graphql_api(Client, SourceApiIdentifier, Input)

View Source
Creates an association between a Merged API and source API using the source API's identifier.
Link to this function

associate_merged_graphql_api(Client, SourceApiIdentifier, Input0, Options0)

View Source
Link to this function

associate_source_graphql_api(Client, MergedApiIdentifier, Input)

View Source
Creates an association between a Merged API and source API using the Merged API's identifier.
Link to this function

associate_source_graphql_api(Client, MergedApiIdentifier, Input0, Options0)

View Source
Link to this function

create_api_cache(Client, ApiId, Input)

View Source
Creates a cache for the GraphQL API.
Link to this function

create_api_cache(Client, ApiId, Input0, Options0)

View Source
Link to this function

create_api_key(Client, ApiId, Input)

View Source
Creates a unique key that you can distribute to clients who invoke your API.
Link to this function

create_api_key(Client, ApiId, Input0, Options0)

View Source
Link to this function

create_data_source(Client, ApiId, Input)

View Source
Creates a DataSource object.
Link to this function

create_data_source(Client, ApiId, Input0, Options0)

View Source
Link to this function

create_domain_name(Client, Input)

View Source
Creates a custom DomainName object.
Link to this function

create_domain_name(Client, Input0, Options0)

View Source
Link to this function

create_function(Client, ApiId, Input)

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_function(Client, ApiId, Input0, Options0)

View Source
Link to this function

create_graphql_api(Client, Input)

View Source
Creates a GraphqlApi object.
Link to this function

create_graphql_api(Client, Input0, Options0)

View Source
Link to this function

create_resolver(Client, ApiId, TypeName, Input)

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_resolver(Client, ApiId, TypeName, Input0, Options0)

View Source
Link to this function

create_type(Client, ApiId, Input)

View Source
Creates a Type object.
Link to this function

create_type(Client, ApiId, Input0, Options0)

View Source
Link to this function

delete_api_cache(Client, ApiId, Input)

View Source
Deletes an ApiCache object.
Link to this function

delete_api_cache(Client, ApiId, Input0, Options0)

View Source
Link to this function

delete_api_key(Client, ApiId, Id, Input)

View Source
Deletes an API key.
Link to this function

delete_api_key(Client, ApiId, Id, Input0, Options0)

View Source
Link to this function

delete_data_source(Client, ApiId, Name, Input)

View Source
Deletes a DataSource object.
Link to this function

delete_data_source(Client, ApiId, Name, Input0, Options0)

View Source
Link to this function

delete_domain_name(Client, DomainName, Input)

View Source
Deletes a custom DomainName object.
Link to this function

delete_domain_name(Client, DomainName, Input0, Options0)

View Source
Link to this function

delete_function(Client, ApiId, FunctionId, Input)

View Source
Deletes a Function.
Link to this function

delete_function(Client, ApiId, FunctionId, Input0, Options0)

View Source
Link to this function

delete_graphql_api(Client, ApiId, Input)

View Source
Deletes a GraphqlApi object.
Link to this function

delete_graphql_api(Client, ApiId, Input0, Options0)

View Source
Link to this function

delete_resolver(Client, ApiId, FieldName, TypeName, Input)

View Source
Deletes a Resolver object.
Link to this function

delete_resolver(Client, ApiId, FieldName, TypeName, Input0, Options0)

View Source
Link to this function

delete_type(Client, ApiId, TypeName, Input)

View Source
Deletes a Type object.
Link to this function

delete_type(Client, ApiId, TypeName, Input0, Options0)

View Source
Link to this function

disassociate_api(Client, DomainName, Input)

View Source
Removes an ApiAssociation object from a custom domain.
Link to this function

disassociate_api(Client, DomainName, Input0, Options0)

View Source
Link to this function

disassociate_merged_graphql_api(Client, AssociationId, SourceApiIdentifier, Input)

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_merged_graphql_api(Client, AssociationId, SourceApiIdentifier, Input0, Options0)

View Source
Link to this function

disassociate_source_graphql_api(Client, AssociationId, MergedApiIdentifier, Input)

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

disassociate_source_graphql_api(Client, AssociationId, MergedApiIdentifier, Input0, Options0)

View Source
Link to this function

evaluate_code(Client, Input)

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_code(Client, Input0, Options0)

View Source
Link to this function

evaluate_mapping_template(Client, Input)

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

evaluate_mapping_template(Client, Input0, Options0)

View Source
Link to this function

flush_api_cache(Client, ApiId, Input)

View Source
Flushes an ApiCache object.
Link to this function

flush_api_cache(Client, ApiId, Input0, Options0)

View Source
Link to this function

get_api_association(Client, DomainName)

View Source
Retrieves an ApiAssociation object.
Link to this function

get_api_association(Client, DomainName, QueryMap, HeadersMap)

View Source
Link to this function

get_api_association(Client, DomainName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_api_cache(Client, ApiId)

View Source
Retrieves an ApiCache object.
Link to this function

get_api_cache(Client, ApiId, QueryMap, HeadersMap)

View Source
Link to this function

get_api_cache(Client, ApiId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_data_source(Client, ApiId, Name)

View Source
Retrieves a DataSource object.
Link to this function

get_data_source(Client, ApiId, Name, QueryMap, HeadersMap)

View Source
Link to this function

get_data_source(Client, ApiId, Name, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_data_source_introspection(Client, IntrospectionId)

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_data_source_introspection(Client, IntrospectionId, QueryMap, HeadersMap)

View Source
Link to this function

get_data_source_introspection(Client, IntrospectionId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_domain_name(Client, DomainName)

View Source
Retrieves a custom DomainName object.
Link to this function

get_domain_name(Client, DomainName, QueryMap, HeadersMap)

View Source
Link to this function

get_domain_name(Client, DomainName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_function(Client, ApiId, FunctionId)

View Source
Get a Function.
Link to this function

get_function(Client, ApiId, FunctionId, QueryMap, HeadersMap)

View Source
Link to this function

get_function(Client, ApiId, FunctionId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_graphql_api(Client, ApiId)

View Source
Retrieves a GraphqlApi object.
Link to this function

get_graphql_api(Client, ApiId, QueryMap, HeadersMap)

View Source
Link to this function

get_graphql_api(Client, ApiId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_graphql_api_environment_variables(Client, ApiId)

View Source
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
Link to this function

get_graphql_api_environment_variables(Client, ApiId, QueryMap, HeadersMap)

View Source
Link to this function

get_graphql_api_environment_variables(Client, ApiId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_introspection_schema(Client, ApiId, Format)

View Source
Retrieves the introspection schema for a GraphQL API.
Link to this function

get_introspection_schema(Client, ApiId, Format, QueryMap, HeadersMap)

View Source
Link to this function

get_introspection_schema(Client, ApiId, Format, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_resolver(Client, ApiId, FieldName, TypeName)

View Source
Retrieves a Resolver object.
Link to this function

get_resolver(Client, ApiId, FieldName, TypeName, QueryMap, HeadersMap)

View Source
Link to this function

get_resolver(Client, ApiId, FieldName, TypeName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_schema_creation_status(Client, ApiId)

View Source
Retrieves the current status of a schema creation operation.
Link to this function

get_schema_creation_status(Client, ApiId, QueryMap, HeadersMap)

View Source
Link to this function

get_schema_creation_status(Client, ApiId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_source_api_association(Client, AssociationId, MergedApiIdentifier)

View Source
Retrieves a SourceApiAssociation object.
Link to this function

get_source_api_association(Client, AssociationId, MergedApiIdentifier, QueryMap, HeadersMap)

View Source
Link to this function

get_source_api_association(Client, AssociationId, MergedApiIdentifier, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_type(Client, ApiId, TypeName, Format)

View Source
Retrieves a Type object.
Link to this function

get_type(Client, ApiId, TypeName, Format, QueryMap, HeadersMap)

View Source
Link to this function

get_type(Client, ApiId, TypeName, Format, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_api_keys(Client, ApiId)

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_api_keys(Client, ApiId, QueryMap, HeadersMap)

View Source
Link to this function

list_api_keys(Client, ApiId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_data_sources(Client, ApiId)

View Source
Lists the data sources for a given API.
Link to this function

list_data_sources(Client, ApiId, QueryMap, HeadersMap)

View Source
Link to this function

list_data_sources(Client, ApiId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_domain_names(Client)

View Source
Lists multiple custom domain names.
Link to this function

list_domain_names(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_domain_names(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_functions(Client, ApiId)

View Source
List multiple functions.
Link to this function

list_functions(Client, ApiId, QueryMap, HeadersMap)

View Source
Link to this function

list_functions(Client, ApiId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_graphql_apis(Client)

View Source
Lists your GraphQL APIs.
Link to this function

list_graphql_apis(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_graphql_apis(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_resolvers(Client, ApiId, TypeName)

View Source
Lists the resolvers for a given API and type.
Link to this function

list_resolvers(Client, ApiId, TypeName, QueryMap, HeadersMap)

View Source
Link to this function

list_resolvers(Client, ApiId, TypeName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_resolvers_by_function(Client, ApiId, FunctionId)

View Source
List the resolvers that are associated with a specific function.
Link to this function

list_resolvers_by_function(Client, ApiId, FunctionId, QueryMap, HeadersMap)

View Source
Link to this function

list_resolvers_by_function(Client, ApiId, FunctionId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_source_api_associations(Client, ApiId)

View Source
Lists the SourceApiAssociationSummary data.
Link to this function

list_source_api_associations(Client, ApiId, QueryMap, HeadersMap)

View Source
Link to this function

list_source_api_associations(Client, ApiId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn)

View Source
Lists the tags for a resource.
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_types(Client, ApiId, Format)

View Source
Lists the types for a given API.
Link to this function

list_types(Client, ApiId, Format, QueryMap, HeadersMap)

View Source
Link to this function

list_types(Client, ApiId, Format, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_types_by_association(Client, AssociationId, MergedApiIdentifier, Format)

View Source
Lists Type objects by the source API association ID.
Link to this function

list_types_by_association(Client, AssociationId, MergedApiIdentifier, Format, QueryMap, HeadersMap)

View Source
Link to this function

list_types_by_association(Client, AssociationId, MergedApiIdentifier, Format, QueryMap, HeadersMap, Options0)

View Source
Link to this function

put_graphql_api_environment_variables(Client, ApiId, Input)

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

put_graphql_api_environment_variables(Client, ApiId, Input0, Options0)

View Source
Link to this function

start_data_source_introspection(Client, Input)

View Source

Creates a new introspection.

Returns the introspectionId of the new introspection after its creation.
Link to this function

start_data_source_introspection(Client, Input0, Options0)

View Source
Link to this function

start_schema_creation(Client, ApiId, Input)

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_creation(Client, ApiId, Input0, Options0)

View Source
Link to this function

start_schema_merge(Client, AssociationId, MergedApiIdentifier, Input)

View Source

Initiates a merge operation.

Returns a status that shows the result of the merge operation.
Link to this function

start_schema_merge(Client, AssociationId, MergedApiIdentifier, Input0, Options0)

View Source
Link to this function

tag_resource(Client, ResourceArn, Input)

View Source
Tags a resource with user-supplied tags.
Link to this function

tag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

untag_resource(Client, ResourceArn, Input)

View Source
Untags a resource.
Link to this function

untag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

update_api_cache(Client, ApiId, Input)

View Source
Updates the cache for the GraphQL API.
Link to this function

update_api_cache(Client, ApiId, Input0, Options0)

View Source
Link to this function

update_api_key(Client, ApiId, Id, Input)

View Source

Updates an API key.

You can update the key as long as it's not deleted.
Link to this function

update_api_key(Client, ApiId, Id, Input0, Options0)

View Source
Link to this function

update_data_source(Client, ApiId, Name, Input)

View Source
Updates a DataSource object.
Link to this function

update_data_source(Client, ApiId, Name, Input0, Options0)

View Source
Link to this function

update_domain_name(Client, DomainName, Input)

View Source
Updates a custom DomainName object.
Link to this function

update_domain_name(Client, DomainName, Input0, Options0)

View Source
Link to this function

update_function(Client, ApiId, FunctionId, Input)

View Source
Updates a Function object.
Link to this function

update_function(Client, ApiId, FunctionId, Input0, Options0)

View Source
Link to this function

update_graphql_api(Client, ApiId, Input)

View Source
Updates a GraphqlApi object.
Link to this function

update_graphql_api(Client, ApiId, Input0, Options0)

View Source
Link to this function

update_resolver(Client, ApiId, FieldName, TypeName, Input)

View Source
Updates a Resolver object.
Link to this function

update_resolver(Client, ApiId, FieldName, TypeName, Input0, Options0)

View Source
Link to this function

update_source_api_association(Client, AssociationId, MergedApiIdentifier, Input)

View Source
Updates some of the configuration choices of a particular source API association.
Link to this function

update_source_api_association(Client, AssociationId, MergedApiIdentifier, Input0, Options0)

View Source
Link to this function

update_type(Client, ApiId, TypeName, Input)

View Source
Updates a Type object.
Link to this function

update_type(Client, ApiId, TypeName, Input0, Options0)

View Source