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.

Classes

NameDescription
Class AccessDeniedException

You do not have access to perform this operation on this resource.

Class AdditionalAuthenticationProvider

Describes an additional authentication provider.

Class ApiCache

The ApiCache object.

Class ApiKey

Describes an API key.

Customers invoke AWS AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:

da1: This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that date.

  • ListApiKeys returns the expiration time in milliseconds.

  • CreateApiKey returns the expiration time in milliseconds.

  • UpdateApiKey is not available for this key version.

  • DeleteApiKey deletes the item from the table.

  • Expiration is stored in Amazon DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we will delete these keys from the table after February 21, 2018.

da2: This version was introduced in February 2018 when AppSync added support to extend key expiration.

  • ListApiKeys returns the expiration time in seconds.

  • CreateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds.

  • UpdateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds. Key expiration can only be updated while the key has not expired.

  • DeleteApiKey deletes the item from the table.

  • Expiration is stored in Amazon DynamoDB as seconds.

Class ApiKeyLimitExceededException

The API key exceeded a limit. Try your request again.

Class ApiKeyValidityOutOfBoundsException

The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey) or from update (for UpdateApiKey).

Class ApiLimitExceededException

The GraphQL API exceeded a limit. Try your request again.

Class AuthorizationConfig

The authorization config in case the HTTP endpoint requires authorization.

Class AwsIamConfig

The AWS IAM configuration.

Class BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

Class CachingConfig

The caching configuration for a resolver that has caching enabled.

Class CognitoUserPoolConfig

Describes an Amazon Cognito user pool configuration.

Class ConcurrentModificationException

Another modification is in progress at this time and it must complete before you can make your change.

Class CreateApiCacheRequest

Container for the parameters to the CreateApiCache operation. Creates a cache for the GraphQL API.

Class CreateApiCacheResponse

Represents the output of a CreateApiCache operation.

Class CreateApiKeyRequest

Container for the parameters to the CreateApiKey operation. Creates a unique key that you can distribute to clients who are executing your API.

Class CreateApiKeyResponse

This is the response object from the CreateApiKey operation.

Class CreateDataSourceRequest

Container for the parameters to the CreateDataSource operation. Creates a DataSource object.

Class CreateDataSourceResponse

This is the response object from the CreateDataSource operation.

Class CreateFunctionRequest

Container for the parameters to the CreateFunction operation. Creates a Function object.

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

Class CreateFunctionResponse

This is the response object from the CreateFunction operation.

Class CreateGraphqlApiRequest

Container for the parameters to the CreateGraphqlApi operation. Creates a GraphqlApi object.

Class CreateGraphqlApiResponse

This is the response object from the CreateGraphqlApi operation.

Class CreateResolverRequest

Container for the parameters to the CreateResolver operation. 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.

Class CreateResolverResponse

This is the response object from the CreateResolver operation.

Class CreateTypeRequest

Container for the parameters to the CreateType operation. Creates a Type object.

Class CreateTypeResponse

This is the response object from the CreateType operation.

Class DataSource

Describes a data source.

Class DeleteApiCacheRequest

Container for the parameters to the DeleteApiCache operation. Deletes an ApiCache object.

Class DeleteApiCacheResponse

Represents the output of a DeleteApiCache operation.

Class DeleteApiKeyRequest

Container for the parameters to the DeleteApiKey operation. Deletes an API key.

Class DeleteApiKeyResponse

This is the response object from the DeleteApiKey operation.

Class DeleteDataSourceRequest

Container for the parameters to the DeleteDataSource operation. Deletes a DataSource object.

Class DeleteDataSourceResponse

This is the response object from the DeleteDataSource operation.

Class DeleteFunctionRequest

Container for the parameters to the DeleteFunction operation. Deletes a Function.

Class DeleteFunctionResponse

This is the response object from the DeleteFunction operation.

Class DeleteGraphqlApiRequest

Container for the parameters to the DeleteGraphqlApi operation. Deletes a GraphqlApi object.

Class DeleteGraphqlApiResponse

This is the response object from the DeleteGraphqlApi operation.

Class DeleteResolverRequest

Container for the parameters to the DeleteResolver operation. Deletes a Resolver object.

Class DeleteResolverResponse

This is the response object from the DeleteResolver operation.

Class DeleteTypeRequest

Container for the parameters to the DeleteType operation. Deletes a Type object.

Class DeleteTypeResponse

This is the response object from the DeleteType operation.

Class DeltaSyncConfig

Describes a Delta Sync configuration.

Class DynamodbDataSourceConfig

Describes an Amazon DynamoDB data source configuration.

Class ElasticsearchDataSourceConfig

Describes an Elasticsearch data source configuration.

Class FlushApiCacheRequest

Container for the parameters to the FlushApiCache operation. Flushes an ApiCache object.

Class FlushApiCacheResponse

Represents the output of a FlushApiCache operation.

Class FunctionConfiguration

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

Class GetApiCacheRequest

Container for the parameters to the GetApiCache operation. Retrieves an ApiCache object.

Class GetApiCacheResponse

Represents the output of a GetApiCache operation.

Class GetDataSourceRequest

Container for the parameters to the GetDataSource operation. Retrieves a DataSource object.

Class GetDataSourceResponse

This is the response object from the GetDataSource operation.

Class GetFunctionRequest

Container for the parameters to the GetFunction operation. Get a Function.

Class GetFunctionResponse

This is the response object from the GetFunction operation.

Class GetGraphqlApiRequest

Container for the parameters to the GetGraphqlApi operation. Retrieves a GraphqlApi object.

Class GetGraphqlApiResponse

This is the response object from the GetGraphqlApi operation.

Class GetIntrospectionSchemaRequest

Container for the parameters to the GetIntrospectionSchema operation. Retrieves the introspection schema for a GraphQL API.

Class GetIntrospectionSchemaResponse

This is the response object from the GetIntrospectionSchema operation.

Class GetResolverRequest

Container for the parameters to the GetResolver operation. Retrieves a Resolver object.

Class GetResolverResponse

This is the response object from the GetResolver operation.

Class GetSchemaCreationStatusRequest

Container for the parameters to the GetSchemaCreationStatus operation. Retrieves the current status of a schema creation operation.

Class GetSchemaCreationStatusResponse

This is the response object from the GetSchemaCreationStatus operation.

Class GetTypeRequest

Container for the parameters to the GetType operation. Retrieves a Type object.

Class GetTypeResponse

This is the response object from the GetType operation.

Class GraphqlApi

Describes a GraphQL API.

Class GraphQLSchemaException

The GraphQL schema is not valid.

Class HttpDataSourceConfig

Describes an HTTP data source configuration.

Class InternalFailureException

An internal AWS AppSync error occurred. Try your request again.

Class LambdaConflictHandlerConfig

The LambdaConflictHandlerConfig object when configuring LAMBDA as the Conflict Handler.

Class LambdaDataSourceConfig

Describes an AWS Lambda data source configuration.

Class LimitExceededException

The request exceeded a limit. Try your request again.

Class ListApiKeysRequest

Container for the parameters to the ListApiKeys operation. 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.

Class ListApiKeysResponse

This is the response object from the ListApiKeys operation.

Class ListDataSourcesRequest

Container for the parameters to the ListDataSources operation. Lists the data sources for a given API.

Class ListDataSourcesResponse

This is the response object from the ListDataSources operation.

Class ListFunctionsRequest

Container for the parameters to the ListFunctions operation. List multiple functions.

Class ListFunctionsResponse

This is the response object from the ListFunctions operation.

Class ListGraphqlApisRequest

Container for the parameters to the ListGraphqlApis operation. Lists your GraphQL APIs.

Class ListGraphqlApisResponse

This is the response object from the ListGraphqlApis operation.

Class ListResolversByFunctionRequest

Container for the parameters to the ListResolversByFunction operation. List the resolvers that are associated with a specific function.

Class ListResolversByFunctionResponse

This is the response object from the ListResolversByFunction operation.

Class ListResolversRequest

Container for the parameters to the ListResolvers operation. Lists the resolvers for a given API and type.

Class ListResolversResponse

This is the response object from the ListResolvers operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists the tags for a resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListTypesRequest

Container for the parameters to the ListTypes operation. Lists the types for a given API.

Class ListTypesResponse

This is the response object from the ListTypes operation.

Class LogConfig

The CloudWatch Logs configuration.

Class NotFoundException

The resource specified in the request was not found. Check the resource, and then try again.

Class OpenIDConnectConfig

Describes an OpenID Connect configuration.

Class PipelineConfig

The pipeline configuration for a resolver of kind PIPELINE.

Class RdsHttpEndpointConfig

The Amazon RDS HTTP endpoint configuration.

Class RelationalDatabaseDataSourceConfig

Describes a relational database data source configuration.

Class Resolver

Describes a resolver.

Class StartSchemaCreationRequest

Container for the parameters to the StartSchemaCreation operation. Adds a new schema to your GraphQL API.

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

Class StartSchemaCreationResponse

This is the response object from the StartSchemaCreation operation.

Class SyncConfig

Describes a Sync configuration for a resolver.

Contains information on which Conflict Detection as well as Resolution strategy should be performed when the resolver is invoked.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Tags a resource with user-supplied tags.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class Type

Describes a type.

Class UnauthorizedException

You are not authorized to perform this operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Untags a resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateApiCacheRequest

Container for the parameters to the UpdateApiCache operation. Updates the cache for the GraphQL API.

Class UpdateApiCacheResponse

Represents the output of a UpdateApiCache operation.

Class UpdateApiKeyRequest

Container for the parameters to the UpdateApiKey operation. Updates an API key.

Class UpdateApiKeyResponse

This is the response object from the UpdateApiKey operation.

Class UpdateDataSourceRequest

Container for the parameters to the UpdateDataSource operation. Updates a DataSource object.

Class UpdateDataSourceResponse

This is the response object from the UpdateDataSource operation.

Class UpdateFunctionRequest

Container for the parameters to the UpdateFunction operation. Updates a Function object.

Class UpdateFunctionResponse

This is the response object from the UpdateFunction operation.

Class UpdateGraphqlApiRequest

Container for the parameters to the UpdateGraphqlApi operation. Updates a GraphqlApi object.

Class UpdateGraphqlApiResponse

This is the response object from the UpdateGraphqlApi operation.

Class UpdateResolverRequest

Container for the parameters to the UpdateResolver operation. Updates a Resolver object.

Class UpdateResolverResponse

This is the response object from the UpdateResolver operation.

Class UpdateTypeRequest

Container for the parameters to the UpdateType operation. Updates a Type object.

Class UpdateTypeResponse

This is the response object from the UpdateType operation.

Class UserPoolConfig

Describes an Amazon Cognito user pool configuration.