AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.AppSync.AmazonAppSyncClient

Namespace: Amazon.AppSync
Assembly: AWSSDK.AppSync.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonAppSyncClient : AmazonServiceClient
         IAmazonAppSync, IAmazonService, IDisposable

The AmazonAppSyncClient type exposes the following members

Constructors

NameDescription
Public Method AmazonAppSyncClient()

Constructs AmazonAppSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAppSyncClient(RegionEndpoint)

Constructs AmazonAppSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAppSyncClient(AmazonAppSyncConfig)

Constructs AmazonAppSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAppSyncClient(AWSCredentials)

Constructs AmazonAppSyncClient with AWS Credentials

Public Method AmazonAppSyncClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAppSyncClient with AWS Credentials

Public Method AmazonAppSyncClient(AWSCredentials, AmazonAppSyncConfig)

Constructs AmazonAppSyncClient with AWS Credentials and an AmazonAppSyncClient Configuration object.

Public Method AmazonAppSyncClient(string, string)

Constructs AmazonAppSyncClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppSyncClient(string, string, RegionEndpoint)

Constructs AmazonAppSyncClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppSyncClient(string, string, AmazonAppSyncConfig)

Constructs AmazonAppSyncClient with AWS Access Key ID, AWS Secret Key and an AmazonAppSyncClient Configuration object.

Public Method AmazonAppSyncClient(string, string, string)

Constructs AmazonAppSyncClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppSyncClient(string, string, string, RegionEndpoint)

Constructs AmazonAppSyncClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppSyncClient(string, string, string, AmazonAppSyncConfig)

Constructs AmazonAppSyncClient with AWS Access Key ID, AWS Secret Key and an AmazonAppSyncClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateApiCache(CreateApiCacheRequest)

Creates a cache for the GraphQL API.

Public Method CreateApiCacheAsync(CreateApiCacheRequest, CancellationToken)

Creates a cache for the GraphQL API.

Public Method CreateApiKey(CreateApiKeyRequest)

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

Public Method CreateApiKeyAsync(CreateApiKeyRequest, CancellationToken)

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

Public Method CreateDataSource(CreateDataSourceRequest)

Creates a DataSource object.

Public Method CreateDataSourceAsync(CreateDataSourceRequest, CancellationToken)

Creates a DataSource object.

Public Method CreateFunction(CreateFunctionRequest)

Creates a Function object.

A function is a reusable entity. Multiple functions can be used to compose the resolver logic.

Public Method CreateFunctionAsync(CreateFunctionRequest, CancellationToken)

Creates a Function object.

A function is a reusable entity. Multiple functions can be used to compose the resolver logic.

Public Method CreateGraphqlApi(CreateGraphqlApiRequest)

Creates a GraphqlApi object.

Public Method CreateGraphqlApiAsync(CreateGraphqlApiRequest, CancellationToken)

Creates a GraphqlApi object.

Public Method CreateResolver(CreateResolverRequest)

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.

Public Method CreateResolverAsync(CreateResolverRequest, CancellationToken)

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.

Public Method CreateType(CreateTypeRequest)

Creates a Type object.

Public Method CreateTypeAsync(CreateTypeRequest, CancellationToken)

Creates a Type object.

Public Method DeleteApiCache(DeleteApiCacheRequest)

Deletes an ApiCache object.

Public Method DeleteApiCacheAsync(DeleteApiCacheRequest, CancellationToken)

Deletes an ApiCache object.

Public Method DeleteApiKey(DeleteApiKeyRequest)

Deletes an API key.

Public Method DeleteApiKeyAsync(DeleteApiKeyRequest, CancellationToken)

Deletes an API key.

Public Method DeleteDataSource(DeleteDataSourceRequest)

Deletes a DataSource object.

Public Method DeleteDataSourceAsync(DeleteDataSourceRequest, CancellationToken)

Deletes a DataSource object.

Public Method DeleteFunction(DeleteFunctionRequest)

Deletes a Function.

Public Method DeleteFunctionAsync(DeleteFunctionRequest, CancellationToken)

Deletes a Function.

Public Method DeleteGraphqlApi(DeleteGraphqlApiRequest)

Deletes a GraphqlApi object.

Public Method DeleteGraphqlApiAsync(DeleteGraphqlApiRequest, CancellationToken)

Deletes a GraphqlApi object.

Public Method DeleteResolver(DeleteResolverRequest)

Deletes a Resolver object.

Public Method DeleteResolverAsync(DeleteResolverRequest, CancellationToken)

Deletes a Resolver object.

Public Method DeleteType(DeleteTypeRequest)

Deletes a Type object.

Public Method DeleteTypeAsync(DeleteTypeRequest, CancellationToken)

Deletes a Type object.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method FlushApiCache(FlushApiCacheRequest)

Flushes an ApiCache object.

Public Method FlushApiCacheAsync(FlushApiCacheRequest, CancellationToken)

Flushes an ApiCache object.

Public Method GetApiCache(GetApiCacheRequest)

Retrieves an ApiCache object.

Public Method GetApiCacheAsync(GetApiCacheRequest, CancellationToken)

Retrieves an ApiCache object.

Public Method GetDataSource(GetDataSourceRequest)

Retrieves a DataSource object.

Public Method GetDataSourceAsync(GetDataSourceRequest, CancellationToken)

Retrieves a DataSource object.

Public Method GetFunction(GetFunctionRequest)

Get a Function.

Public Method GetFunctionAsync(GetFunctionRequest, CancellationToken)

Get a Function.

Public Method GetGraphqlApi(GetGraphqlApiRequest)

Retrieves a GraphqlApi object.

Public Method GetGraphqlApiAsync(GetGraphqlApiRequest, CancellationToken)

Retrieves a GraphqlApi object.

Public Method GetIntrospectionSchema(GetIntrospectionSchemaRequest)

Retrieves the introspection schema for a GraphQL API.

Public Method GetIntrospectionSchemaAsync(GetIntrospectionSchemaRequest, CancellationToken)

Retrieves the introspection schema for a GraphQL API.

Public Method GetResolver(GetResolverRequest)

Retrieves a Resolver object.

Public Method GetResolverAsync(GetResolverRequest, CancellationToken)

Retrieves a Resolver object.

Public Method GetSchemaCreationStatus(GetSchemaCreationStatusRequest)

Retrieves the current status of a schema creation operation.

Public Method GetSchemaCreationStatusAsync(GetSchemaCreationStatusRequest, CancellationToken)

Retrieves the current status of a schema creation operation.

Public Method GetType(GetTypeRequest)

Retrieves a Type object.

Public Method GetTypeAsync(GetTypeRequest, CancellationToken)

Retrieves a Type object.

Public Method ListApiKeys(ListApiKeysRequest)

Lists the API keys for a given API.

API keys are deleted automatically sometime 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.

Public Method ListApiKeysAsync(ListApiKeysRequest, CancellationToken)

Lists the API keys for a given API.

API keys are deleted automatically sometime 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.

Public Method ListDataSources(ListDataSourcesRequest)

Lists the data sources for a given API.

Public Method ListDataSourcesAsync(ListDataSourcesRequest, CancellationToken)

Lists the data sources for a given API.

Public Method ListFunctions(ListFunctionsRequest)

List multiple functions.

Public Method ListFunctionsAsync(ListFunctionsRequest, CancellationToken)

List multiple functions.

Public Method ListGraphqlApis(ListGraphqlApisRequest)

Lists your GraphQL APIs.

Public Method ListGraphqlApisAsync(ListGraphqlApisRequest, CancellationToken)

Lists your GraphQL APIs.

Public Method ListResolvers(ListResolversRequest)

Lists the resolvers for a given API and type.

Public Method ListResolversAsync(ListResolversRequest, CancellationToken)

Lists the resolvers for a given API and type.

Public Method ListResolversByFunction(ListResolversByFunctionRequest)

List the resolvers that are associated with a specific function.

Public Method ListResolversByFunctionAsync(ListResolversByFunctionRequest, CancellationToken)

List the resolvers that are associated with a specific function.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists the tags for a resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists the tags for a resource.

Public Method ListTypes(ListTypesRequest)

Lists the types for a given API.

Public Method ListTypesAsync(ListTypesRequest, CancellationToken)

Lists the types for a given API.

Public Method StartSchemaCreation(StartSchemaCreationRequest)

Adds a new schema to your GraphQL API.

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

Public Method StartSchemaCreationAsync(StartSchemaCreationRequest, CancellationToken)

Adds a new schema to your GraphQL API.

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

Public Method TagResource(TagResourceRequest)

Tags a resource with user-supplied tags.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Tags a resource with user-supplied tags.

Public Method UntagResource(UntagResourceRequest)

Untags a resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Untags a resource.

Public Method UpdateApiCache(UpdateApiCacheRequest)

Updates the cache for the GraphQL API.

Public Method UpdateApiCacheAsync(UpdateApiCacheRequest, CancellationToken)

Updates the cache for the GraphQL API.

Public Method UpdateApiKey(UpdateApiKeyRequest)

Updates an API key.

Public Method UpdateApiKeyAsync(UpdateApiKeyRequest, CancellationToken)

Updates an API key.

Public Method UpdateDataSource(UpdateDataSourceRequest)

Updates a DataSource object.

Public Method UpdateDataSourceAsync(UpdateDataSourceRequest, CancellationToken)

Updates a DataSource object.

Public Method UpdateFunction(UpdateFunctionRequest)

Updates a Function object.

Public Method UpdateFunctionAsync(UpdateFunctionRequest, CancellationToken)

Updates a Function object.

Public Method UpdateGraphqlApi(UpdateGraphqlApiRequest)

Updates a GraphqlApi object.

Public Method UpdateGraphqlApiAsync(UpdateGraphqlApiRequest, CancellationToken)

Updates a GraphqlApi object.

Public Method UpdateResolver(UpdateResolverRequest)

Updates a Resolver object.

Public Method UpdateResolverAsync(UpdateResolverRequest, CancellationToken)

Updates a Resolver object.

Public Method UpdateType(UpdateTypeRequest)

Updates a Type object.

Public Method UpdateTypeAsync(UpdateTypeRequest, CancellationToken)

Updates a Type object.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms