AppSyncClient

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

Properties

Link copied to clipboard
abstract override val config: AppSyncClient.Config

AppSyncClient's configuration

Functions

Link copied to clipboard

Maps an endpoint to your custom domain.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun createApi(input: CreateApiRequest): CreateApiResponse

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.

Link copied to clipboard

Creates a cache for the GraphQL API.

Link copied to clipboard

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

Link copied to clipboard

Creates a ChannelNamespace for an Api.

Link copied to clipboard

Creates a DataSource object.

Link copied to clipboard

Creates a custom DomainName object.

Link copied to clipboard

Creates a Function object.

Link copied to clipboard

Creates a GraphqlApi object.

Link copied to clipboard

Creates a Resolver object.

Link copied to clipboard
abstract suspend fun createType(input: CreateTypeRequest): CreateTypeResponse

Creates a Type object.

Link copied to clipboard
abstract suspend fun deleteApi(input: DeleteApiRequest): DeleteApiResponse

Deletes an Api object

Link copied to clipboard

Deletes an ApiCache object.

Link copied to clipboard

Deletes an API key.

Link copied to clipboard

Deletes a ChannelNamespace.

Link copied to clipboard

Deletes a DataSource object.

Link copied to clipboard

Deletes a custom DomainName object.

Link copied to clipboard

Deletes a Function.

Link copied to clipboard

Deletes a GraphqlApi object.

Link copied to clipboard

Deletes a Resolver object.

Link copied to clipboard
abstract suspend fun deleteType(input: DeleteTypeRequest): DeleteTypeResponse

Deletes a Type object.

Link copied to clipboard

Removes an ApiAssociation object from a custom domain.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

Evaluates a given template and returns the response. The mapping template can be a request or response template.

Link copied to clipboard

Flushes an ApiCache object.

Link copied to clipboard
abstract suspend fun getApi(input: GetApiRequest): GetApiResponse

Retrieves an Api object.

Link copied to clipboard

Retrieves an ApiAssociation object.

Link copied to clipboard
abstract suspend fun getApiCache(input: GetApiCacheRequest): GetApiCacheResponse

Retrieves an ApiCache object.

Link copied to clipboard

Retrieves the channel namespace for a specified Api.

Link copied to clipboard

Retrieves a DataSource object.

Link copied to clipboard

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 copied to clipboard

Retrieves a custom DomainName object.

Link copied to clipboard
abstract suspend fun getFunction(input: GetFunctionRequest): GetFunctionResponse

Get a Function.

Link copied to clipboard

Retrieves a GraphqlApi object.

Link copied to clipboard

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

Link copied to clipboard

Retrieves the introspection schema for a GraphQL API.

Link copied to clipboard
abstract suspend fun getResolver(input: GetResolverRequest): GetResolverResponse

Retrieves a Resolver object.

Link copied to clipboard

Retrieves the current status of a schema creation operation.

Link copied to clipboard

Retrieves a SourceApiAssociation object.

Link copied to clipboard
abstract suspend fun getType(input: GetTypeRequest): GetTypeResponse

Retrieves a Type object.

Link copied to clipboard
abstract suspend fun listApiKeys(input: ListApiKeysRequest): ListApiKeysResponse

Lists the API keys for a given API.

Link copied to clipboard
abstract suspend fun listApis(input: ListApisRequest = ListApisRequest { }): ListApisResponse

Lists the APIs in your AppSync account.

Link copied to clipboard

Lists the channel namespaces for a specified Api.

Link copied to clipboard

Lists the data sources for a given API.

Link copied to clipboard
abstract suspend fun listDomainNames(input: ListDomainNamesRequest = ListDomainNamesRequest { }): ListDomainNamesResponse

Lists multiple custom domain names.

Link copied to clipboard

List multiple functions.

Link copied to clipboard
abstract suspend fun listGraphqlApis(input: ListGraphqlApisRequest = ListGraphqlApisRequest { }): ListGraphqlApisResponse

Lists your GraphQL APIs.

Link copied to clipboard

Lists the resolvers for a given API and type.

Link copied to clipboard

List the resolvers that are associated with a specific function.

Link copied to clipboard

Lists the SourceApiAssociationSummary data.

Link copied to clipboard

Lists the tags for a resource.

Link copied to clipboard
abstract suspend fun listTypes(input: ListTypesRequest): ListTypesResponse

Lists the types for a given API.

Link copied to clipboard

Lists Type objects by the source API association ID.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun startDataSourceIntrospection(input: StartDataSourceIntrospectionRequest = StartDataSourceIntrospectionRequest { }): StartDataSourceIntrospectionResponse

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

Link copied to clipboard

Adds a new schema to your GraphQL API.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tags a resource with user-supplied tags.

Link copied to clipboard

Untags a resource.

Link copied to clipboard
abstract suspend fun updateApi(input: UpdateApiRequest): UpdateApiResponse

Updates an Api.

Link copied to clipboard

Updates the cache for the GraphQL API.

Link copied to clipboard

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

Link copied to clipboard

Updates a ChannelNamespace associated with an Api.

Link copied to clipboard

Updates a DataSource object.

Link copied to clipboard

Updates a custom DomainName object.

Link copied to clipboard

Updates a Function object.

Link copied to clipboard

Updates a GraphqlApi object.

Link copied to clipboard

Updates a Resolver object.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun updateType(input: UpdateTypeRequest): UpdateTypeResponse

Updates a Type object.

Inherited functions

Link copied to clipboard

Maps an endpoint to your custom domain.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun AppSyncClient.createApi(crossinline block: CreateApiRequest.Builder.() -> Unit): CreateApiResponse

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.

Link copied to clipboard

Creates a cache for the GraphQL API.

Link copied to clipboard

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

Link copied to clipboard

Creates a ChannelNamespace for an Api.

Link copied to clipboard

Creates a DataSource object.

Link copied to clipboard

Creates a custom DomainName object.

Link copied to clipboard

Creates a Function object.

Link copied to clipboard

Creates a GraphqlApi object.

Link copied to clipboard

Creates a Resolver object.

Link copied to clipboard
inline suspend fun AppSyncClient.createType(crossinline block: CreateTypeRequest.Builder.() -> Unit): CreateTypeResponse

Creates a Type object.

Link copied to clipboard
inline suspend fun AppSyncClient.deleteApi(crossinline block: DeleteApiRequest.Builder.() -> Unit): DeleteApiResponse

Deletes an Api object

Link copied to clipboard

Deletes an ApiCache object.

Link copied to clipboard

Deletes an API key.

Link copied to clipboard

Deletes a ChannelNamespace.

Link copied to clipboard

Deletes a DataSource object.

Link copied to clipboard

Deletes a custom DomainName object.

Link copied to clipboard

Deletes a Function.

Link copied to clipboard

Deletes a GraphqlApi object.

Link copied to clipboard

Deletes a Resolver object.

Link copied to clipboard
inline suspend fun AppSyncClient.deleteType(crossinline block: DeleteTypeRequest.Builder.() -> Unit): DeleteTypeResponse

Deletes a Type object.

Link copied to clipboard

Removes an ApiAssociation object from a custom domain.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

Evaluates a given template and returns the response. The mapping template can be a request or response template.

Link copied to clipboard

Flushes an ApiCache object.

Link copied to clipboard
inline suspend fun AppSyncClient.getApi(crossinline block: GetApiRequest.Builder.() -> Unit): GetApiResponse

Retrieves an Api object.

Link copied to clipboard

Retrieves an ApiAssociation object.

Link copied to clipboard
inline suspend fun AppSyncClient.getApiCache(crossinline block: GetApiCacheRequest.Builder.() -> Unit): GetApiCacheResponse

Retrieves an ApiCache object.

Link copied to clipboard

Retrieves the channel namespace for a specified Api.

Link copied to clipboard

Retrieves a DataSource object.

Link copied to clipboard

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 copied to clipboard

Retrieves a custom DomainName object.

Link copied to clipboard
inline suspend fun AppSyncClient.getFunction(crossinline block: GetFunctionRequest.Builder.() -> Unit): GetFunctionResponse

Get a Function.

Link copied to clipboard

Retrieves a GraphqlApi object.

Link copied to clipboard

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

Link copied to clipboard

Retrieves the introspection schema for a GraphQL API.

Link copied to clipboard
inline suspend fun AppSyncClient.getResolver(crossinline block: GetResolverRequest.Builder.() -> Unit): GetResolverResponse

Retrieves a Resolver object.

Link copied to clipboard

Retrieves the current status of a schema creation operation.

Link copied to clipboard

Retrieves a SourceApiAssociation object.

Link copied to clipboard
inline suspend fun AppSyncClient.getType(crossinline block: GetTypeRequest.Builder.() -> Unit): GetTypeResponse

Retrieves a Type object.

Link copied to clipboard
inline suspend fun AppSyncClient.listApiKeys(crossinline block: ListApiKeysRequest.Builder.() -> Unit): ListApiKeysResponse

Lists the API keys for a given API.

Link copied to clipboard
inline suspend fun AppSyncClient.listApis(crossinline block: ListApisRequest.Builder.() -> Unit): ListApisResponse

Lists the APIs in your AppSync account.

Link copied to clipboard
fun AppSyncClient.listApisPaginated(initialRequest: ListApisRequest = ListApisRequest { }): Flow<ListApisResponse>

Paginate over ListApisResponse results.

Link copied to clipboard

Lists the channel namespaces for a specified Api.

Link copied to clipboard

Lists the data sources for a given API.

Link copied to clipboard

Lists multiple custom domain names.

Link copied to clipboard

List multiple functions.

Link copied to clipboard

Lists your GraphQL APIs.

Link copied to clipboard

Lists the resolvers for a given API and type.

Link copied to clipboard

List the resolvers that are associated with a specific function.

Link copied to clipboard

Lists the SourceApiAssociationSummary data.

Link copied to clipboard

Lists the tags for a resource.

Link copied to clipboard
inline suspend fun AppSyncClient.listTypes(crossinline block: ListTypesRequest.Builder.() -> Unit): ListTypesResponse

Lists the types for a given API.

Link copied to clipboard

Lists Type objects by the source API association ID.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Adds a new schema to your GraphQL API.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun AppSyncClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tags a resource with user-supplied tags.

Link copied to clipboard

Untags a resource.

Link copied to clipboard
inline suspend fun AppSyncClient.updateApi(crossinline block: UpdateApiRequest.Builder.() -> Unit): UpdateApiResponse

Updates an Api.

Link copied to clipboard

Updates the cache for the GraphQL API.

Link copied to clipboard

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

Link copied to clipboard

Updates a ChannelNamespace associated with an Api.

Link copied to clipboard

Updates a DataSource object.

Link copied to clipboard

Updates a custom DomainName object.

Link copied to clipboard

Updates a Function object.

Link copied to clipboard

Updates a GraphqlApi object.

Link copied to clipboard

Updates a Resolver object.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun AppSyncClient.updateType(crossinline block: UpdateTypeRequest.Builder.() -> Unit): UpdateTypeResponse

Updates a Type object.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.