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.

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

Inheritance Hierarchy

Amazon.AppSync.IAmazonAppSync

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

Syntax

C#
public interface IAmazonAppSync
         IAmazonService, IDisposable

The IAmazonAppSync type exposes the following members

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 CreateApiKey(CreateApiKeyRequest)

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

Public Method CreateApiKeyAsync(CreateApiKeyRequest, CancellationToken)

Initiates the asynchronous execution of the CreateApiKey operation.

Public Method CreateDataSource(CreateDataSourceRequest)

Creates a DataSource object.

Public Method CreateDataSourceAsync(CreateDataSourceRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDataSource operation.

Public Method CreateGraphqlApi(CreateGraphqlApiRequest)

Creates a GraphqlApi object.

Public Method CreateGraphqlApiAsync(CreateGraphqlApiRequest, CancellationToken)

Initiates the asynchronous execution of the CreateGraphqlApi operation.

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)

Initiates the asynchronous execution of the CreateResolver operation.

Public Method CreateType(CreateTypeRequest)

Creates a Type object.

Public Method CreateTypeAsync(CreateTypeRequest, CancellationToken)

Initiates the asynchronous execution of the CreateType operation.

Public Method DeleteApiKey(DeleteApiKeyRequest)

Deletes an API key.

Public Method DeleteApiKeyAsync(DeleteApiKeyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteApiKey operation.

Public Method DeleteDataSource(DeleteDataSourceRequest)

Deletes a DataSource object.

Public Method DeleteDataSourceAsync(DeleteDataSourceRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDataSource operation.

Public Method DeleteGraphqlApi(DeleteGraphqlApiRequest)

Deletes a GraphqlApi object.

Public Method DeleteGraphqlApiAsync(DeleteGraphqlApiRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteGraphqlApi operation.

Public Method DeleteResolver(DeleteResolverRequest)

Deletes a Resolver object.

Public Method DeleteResolverAsync(DeleteResolverRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteResolver operation.

Public Method DeleteType(DeleteTypeRequest)

Deletes a Type object.

Public Method DeleteTypeAsync(DeleteTypeRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteType operation.

Public Method GetDataSource(GetDataSourceRequest)

Retrieves a DataSource object.

Public Method GetDataSourceAsync(GetDataSourceRequest, CancellationToken)

Initiates the asynchronous execution of the GetDataSource operation.

Public Method GetGraphqlApi(GetGraphqlApiRequest)

Retrieves a GraphqlApi object.

Public Method GetGraphqlApiAsync(GetGraphqlApiRequest, CancellationToken)

Initiates the asynchronous execution of the GetGraphqlApi operation.

Public Method GetIntrospectionSchema(GetIntrospectionSchemaRequest)

Retrieves the introspection schema for a GraphQL API.

Public Method GetIntrospectionSchemaAsync(GetIntrospectionSchemaRequest, CancellationToken)

Initiates the asynchronous execution of the GetIntrospectionSchema operation.

Public Method GetResolver(GetResolverRequest)

Retrieves a Resolver object.

Public Method GetResolverAsync(GetResolverRequest, CancellationToken)

Initiates the asynchronous execution of the GetResolver operation.

Public Method GetSchemaCreationStatus(GetSchemaCreationStatusRequest)

Retrieves the current status of a schema creation operation.

Public Method GetSchemaCreationStatusAsync(GetSchemaCreationStatusRequest, CancellationToken)

Initiates the asynchronous execution of the GetSchemaCreationStatus operation.

Public Method GetType(GetTypeRequest)

Retrieves a Type object.

Public Method GetTypeAsync(GetTypeRequest, CancellationToken)

Initiates the asynchronous execution of the GetType operation.

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)

Initiates the asynchronous execution of the ListApiKeys operation.

Public Method ListDataSources(ListDataSourcesRequest)

Lists the data sources for a given API.

Public Method ListDataSourcesAsync(ListDataSourcesRequest, CancellationToken)

Initiates the asynchronous execution of the ListDataSources operation.

Public Method ListGraphqlApis(ListGraphqlApisRequest)

Lists your GraphQL APIs.

Public Method ListGraphqlApisAsync(ListGraphqlApisRequest, CancellationToken)

Initiates the asynchronous execution of the ListGraphqlApis operation.

Public Method ListResolvers(ListResolversRequest)

Lists the resolvers for a given API and type.

Public Method ListResolversAsync(ListResolversRequest, CancellationToken)

Initiates the asynchronous execution of the ListResolvers operation.

Public Method ListTypes(ListTypesRequest)

Lists the types for a given API.

Public Method ListTypesAsync(ListTypesRequest, CancellationToken)

Initiates the asynchronous execution of the ListTypes operation.

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)

Initiates the asynchronous execution of the StartSchemaCreation operation.

Public Method UpdateApiKey(UpdateApiKeyRequest)

Updates an API key.

Public Method UpdateApiKeyAsync(UpdateApiKeyRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateApiKey operation.

Public Method UpdateDataSource(UpdateDataSourceRequest)

Updates a DataSource object.

Public Method UpdateDataSourceAsync(UpdateDataSourceRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDataSource operation.

Public Method UpdateGraphqlApi(UpdateGraphqlApiRequest)

Updates a GraphqlApi object.

Public Method UpdateGraphqlApiAsync(UpdateGraphqlApiRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateGraphqlApi operation.

Public Method UpdateResolver(UpdateResolverRequest)

Updates a Resolver object.

Public Method UpdateResolverAsync(UpdateResolverRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateResolver operation.

Public Method UpdateType(UpdateTypeRequest)

Updates a Type object.

Public Method UpdateTypeAsync(UpdateTypeRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateType operation.

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