AWS AppSync
AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
AppSync provides API actions for creating and interacting with data
sources using GraphQL from your application.
Endpoints 74
- GETGet api association
/v1/domainnames/:domainName/apiassociationRetrieves an ApiAssociation object. - POSTAssociate api
/v1/domainnames/:domainName/apiassociationMaps an endpoint to your custom domain. - DELETEDisassociate api
/v1/domainnames/:domainName/apiassociationRemoves an ApiAssociation object from a custom domain. - POSTAssociate merged graphql api
/v1/sourceApis/:sourceApiIdentifier/mergedApiAssociationsCreates an association between a Merged API and source API using the source API's identifier. - POSTAssociate source graphql api
/v1/mergedApis/:mergedApiIdentifier/sourceApiAssociationsCreates an association between a Merged API and source API using the Merged API's identifier. - GETList apis
/v2/apis?nextToken=string&maxResults=0Lists the APIs in your AppSync account. ListApis returns only the high level API details. For more detailed information about an API, use GetApi . - POSTCreate api
/v2/apisCreates 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… - GETGet api cache
/v1/apis/:apiId/ApiCachesRetrieves an ApiCache object. - POSTCreate api cache
/v1/apis/:apiId/ApiCachesCreates a cache for the GraphQL API. - DELETEDelete api cache
/v1/apis/:apiId/ApiCachesDeletes an ApiCache object. - GETList api keys
/v1/apis/:apiId/apikeys?nextToken=string&maxResults=0Lists 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… - POSTCreate api key
/v1/apis/:apiId/apikeysCreates a unique key that you can distribute to clients who invoke your API. - GETList channel namespaces
/v2/apis/:apiId/channelNamespaces?nextToken=string&maxResults=0Lists the channel namespaces for a specified Api . ListChannelNamespaces returns only high level details for the channel namespace. To retrieve code handlers,… - POSTCreate channel namespace
/v2/apis/:apiId/channelNamespacesCreates a ChannelNamespace for an Api . - GETList data sources
/v1/apis/:apiId/datasources?nextToken=string&maxResults=0Lists the data sources for a given API. - POSTCreate data source
/v1/apis/:apiId/datasourcesCreates a DataSource object. - GETList domain names
/v1/domainnames?nextToken=string&maxResults=0Lists multiple custom domain names. - POSTCreate domain name
/v1/domainnamesCreates a custom DomainName object. - GETList functions
/v1/apis/:apiId/functions?nextToken=string&maxResults=0List multiple functions. - POSTCreate function
/v1/apis/:apiId/functionsCreates a Function object. A function is a reusable entity. You can use multiple functions to compose the resolver logic. - GETList graphql apis
/v1/apis?nextToken=string&maxResults=0&apiType=string&owner=stringLists your GraphQL APIs. - POSTCreate graphql api
/v1/apisCreates a GraphqlApi object. - GETList resolvers
/v1/apis/:apiId/types/:typeName/resolvers?nextToken=string&maxResults=0Lists the resolvers for a given API and type. - POSTCreate resolver
/v1/apis/:apiId/types/:typeName/resolversCreates a Resolver object. A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses… - GETList types
/v1/apis/:apiId/types?format=string&nextToken=string&maxResults=0Lists the types for a given API. - POSTCreate type
/v1/apis/:apiId/typesCreates a Type object. - GETGet api
/v2/apis/:apiIdRetrieves an Api object. - POSTUpdate api
/v2/apis/:apiIdUpdates an Api . - DELETEDelete api
/v2/apis/:apiIdDeletes an Api object - POSTUpdate api key
/v1/apis/:apiId/apikeys/:idUpdates an API key. You can update the key as long as it's not deleted. - DELETEDelete api key
/v1/apis/:apiId/apikeys/:idDeletes an API key. - GETGet channel namespace
/v2/apis/:apiId/channelNamespaces/:nameRetrieves the channel namespace for a specified Api . - POSTUpdate channel namespace
/v2/apis/:apiId/channelNamespaces/:nameUpdates a ChannelNamespace associated with an Api . - DELETEDelete channel namespace
/v2/apis/:apiId/channelNamespaces/:nameDeletes a ChannelNamespace . - GETGet data source
/v1/apis/:apiId/datasources/:nameRetrieves a DataSource object. - POSTUpdate data source
/v1/apis/:apiId/datasources/:nameUpdates a DataSource object. - DELETEDelete data source
/v1/apis/:apiId/datasources/:nameDeletes a DataSource object. - GETGet domain name
/v1/domainnames/:domainNameRetrieves a custom DomainName object. - POSTUpdate domain name
/v1/domainnames/:domainNameUpdates a custom DomainName object. - DELETEDelete domain name
/v1/domainnames/:domainNameDeletes a custom DomainName object. - GETGet function
/v1/apis/:apiId/functions/:functionIdGet a Function . - POSTUpdate function
/v1/apis/:apiId/functions/:functionIdUpdates a Function object. - DELETEDelete function
/v1/apis/:apiId/functions/:functionIdDeletes a Function . - GETGet graphql api
/v1/apis/:apiIdRetrieves a GraphqlApi object. - POSTUpdate graphql api
/v1/apis/:apiIdUpdates a GraphqlApi object. - DELETEDelete graphql api
/v1/apis/:apiIdDeletes a GraphqlApi object. - GETGet resolver
/v1/apis/:apiId/types/:typeName/resolvers/:fieldNameRetrieves a Resolver object. - POSTUpdate resolver
/v1/apis/:apiId/types/:typeName/resolvers/:fieldNameUpdates a Resolver object. - DELETEDelete resolver
/v1/apis/:apiId/types/:typeName/resolvers/:fieldNameDeletes a Resolver object. - GETGet type
/v1/apis/:apiId/types/:typeName?format=stringRetrieves a Type object. - POSTUpdate type
/v1/apis/:apiId/types/:typeNameUpdates a Type object. - DELETEDelete type
/v1/apis/:apiId/types/:typeNameDeletes a Type object. - DELETEDisassociate merged graphql api
/v1/sourceApis/:sourceApiIdentifier/mergedApiAssociations/:associationIdDeletes an association between a Merged API and source API using the source API's identifier and the association ID. - GETGet source api association
/v1/mergedApis/:mergedApiIdentifier/sourceApiAssociations/:associationIdRetrieves a SourceApiAssociation object. - POSTUpdate source api association
/v1/mergedApis/:mergedApiIdentifier/sourceApiAssociations/:associationIdUpdates some of the configuration choices of a particular source API association. - DELETEDisassociate source graphql api
/v1/mergedApis/:mergedApiIdentifier/sourceApiAssociations/:associationIdDeletes an association between a Merged API and source API using the Merged API's identifier and the association ID. - POSTEvaluate code
/v1/dataplane-evaluatecodeEvaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For APPSYNC_JS runtimes, the code defines… - POSTEvaluate mapping template
/v1/dataplane-evaluatetemplateEvaluates a given template and returns the response. The mapping template can be a request or response template. Request templates take the incoming request… - DELETEFlush api cache
/v1/apis/:apiId/FlushCacheFlushes an ApiCache object. - GETGet data source introspection
/v1/datasources/introspections/:introspectionId?includeModelsSDL=true&nextToken=string&maxResults=0Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval… - GETGet graphql api environment variables
/v1/apis/:apiId/environmentVariablesRetrieves the list of environmental variable key-value pairs associated with an API by its ID value. - PUTPut graphql api environment variables
/v1/apis/:apiId/environmentVariablesCreates a list of environmental variables in an API by its ID value. When creating an environmental variable, it must follow the constraints below: Both… - GETGet introspection schema
/v1/apis/:apiId/schema?format=string&includeDirectives=trueRetrieves the introspection schema for a GraphQL API. - GETGet schema creation status
/v1/apis/:apiId/schemacreationRetrieves the current status of a schema creation operation. - POSTStart schema creation
/v1/apis/:apiId/schemacreationAdds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed. - GETList resolvers by function
/v1/apis/:apiId/functions/:functionId/resolvers?nextToken=string&maxResults=0List the resolvers that are associated with a specific function. - GETList source api associations
/v1/apis/:apiId/sourceApiAssociations?nextToken=string&maxResults=0Lists the SourceApiAssociationSummary data. - GETList tags for resource
/v1/tags/:resourceArnLists the tags for a resource. - POSTTag resource
/v1/tags/:resourceArnTags a resource with user-supplied tags. - DELETEUntag resource
/v1/tags/:resourceArn?tagKeys=Untags a resource. - GETList types by association
/v1/mergedApis/:mergedApiIdentifier/sourceApiAssociations/:associationId/types?format=string&nextToken=string&maxResults=0Lists Type objects by the source API association ID. - POSTStart data source introspection
/v1/datasources/introspectionsCreates a new introspection. Returns the introspectionId of the new introspection after its creation. - POSTStart schema merge
/v1/mergedApis/:mergedApiIdentifier/sourceApiAssociations/:associationId/mergeInitiates a merge operation. Returns a status that shows the result of the merge operation. - POSTUpdate api cache
/v1/apis/:apiId/ApiCaches/updateUpdates the cache for the GraphQL API.
API details
- Base URL
https://appsync.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 74 operations on 38 pathsPOST 30GET 28DELETE 15PUT 1
- Description format
- AWS Smithy model, API version
2017-07-25 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS AppSync in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS AppSync collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get api association” (GET /v1/domainnames/:domainName/apiassociation), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS AppSync?
AppSync provides API actions for creating and interacting with data sources using GraphQL from your application. It is listed under Developer tools and has 74 endpoints.
Who publishes the AWS AppSync?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS AppSync?
Requests go to https://appsync.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS AppSync?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS AppSync have?
74 operations on 38 paths (30 POST, 28 GET, 15 DELETE, 1 PUT).
Is forking the AWS AppSync free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.