AWS Fundamentals Logo
AWS Fundamentals
aws appsync

AWS AWS AppSync CLI Commands

74 CLI commands available for AWS AppSync.

CommandSample
associate-api

Maps an endpoint to your custom domain.

associate-merged-graphql-api

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

associate-source-graphql-api

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

create-api

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.

create-api-cache

Creates a cache for the GraphQL API.

create-api-key

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

create-channel-namespace

Creates a ChannelNamespace for an Api.

create-data-source

Creates a DataSource object.

create-domain-name

Creates a custom DomainName object.

create-function

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

create-graphql-api

Creates a GraphqlApi object.

create-resolver

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.

create-type

Creates a Type object.

delete-api

Deletes an Api object

delete-api-cache

Deletes an ApiCache object.

delete-api-key

Deletes an API key.

delete-channel-namespace

Deletes a ChannelNamespace.

delete-data-source

Deletes a DataSource object.

delete-domain-name

Deletes a custom DomainName object.

delete-function

Deletes a Function.

delete-graphql-api

Deletes a GraphqlApi object.

delete-resolver

Deletes a Resolver object.

delete-type

Deletes a Type object.

disassociate-api

Removes an ApiAssociation object from a custom domain.

disassociate-merged-graphql-api

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

disassociate-source-graphql-api

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

evaluate-code

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

evaluate-mapping-template

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 inte

flush-api-cache

Flushes an ApiCache object.

get-api

Retrieves an Api object.

get-api-association

Retrieves an ApiAssociation object.

get-api-cache

Retrieves an ApiCache object.

get-channel-namespace

Retrieves the channel namespace for a specified Api.

get-data-source

Retrieves a DataSource object.

get-data-source-introspection

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.

get-domain-name

Retrieves a custom DomainName object.

get-function

Get a Function.

get-graphql-api

Retrieves a GraphqlApi object.

get-graphql-api-environment-variables

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

get-introspection-schema

Retrieves the introspection schema for a GraphQL API.

get-resolver

Retrieves a Resolver object.

get-schema-creation-status

Retrieves the current status of a schema creation operation.

get-source-api-association

Retrieves a SourceApiAssociation object.

get-type

Retrieves a Type object.

list-api-keys

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.

list-apis

Lists 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

Lists 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

Lists the data sources for a given API.

list-domain-names

Lists multiple custom domain names.

list-functions

List multiple functions.

list-graphql-apis

Lists your GraphQL APIs.

list-resolvers

Lists the resolvers for a given API and type.

list-resolvers-by-function

List the resolvers that are associated with a specific function.

list-source-api-associations

Lists the SourceApiAssociationSummary data.

list-tags-for-resource

Lists the tags for a resource.

list-types

Lists the types for a given API.

list-types-by-association

Lists Type objects by the source API association ID.

put-graphql-api-environment-variables

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

start-data-source-introspection

Creates a new introspection. Returns the introspectionId of the new introspection after its creation.

start-schema-creation

Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed.

start-schema-merge

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

tag-resource

Tags a resource with user-supplied tags.

untag-resource

Untags a resource.

update-api

Updates an Api.

update-api-cache

Updates the cache for the GraphQL API.

update-api-key

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

update-channel-namespace

Updates a ChannelNamespace associated with an Api.

update-data-source

Updates a DataSource object.

update-domain-name

Updates a custom DomainName object.

update-function

Updates a Function object.

update-graphql-api

Updates a GraphqlApi object.

update-resolver

Updates a Resolver object.

update-source-api-association

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

update-type

Updates a Type object.

Get the AWS AppSync Cheat Sheet

Everything you need to know about AWS AppSync on one page. HD quality, print-friendly.

Download Free Infographic

Get the AWS AppSync Cheat Sheet

Everything you need to know about AWS AppSync on one page. HD quality, print-friendly.

Download Free Infographic

Quick Stats

Total Commands74
ServiceAppSync