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 ApiKey

Describes an API key.

Customers invoke AWS AppSync GraphQL APIs 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 DynamoDB TTL. The keys will cease to be valid after Feb 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 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 Feb 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 DynamoDB as seconds.

Class ApiKeyLimitExceededException

AppSync exception

Class ApiKeyValidityOutOfBoundsException

AppSync exception

Class ApiLimitExceededException

AppSync exception

Class BadRequestException

AppSync exception

Class ConcurrentModificationException

AppSync exception

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 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 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 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 DynamodbDataSourceConfig

Describes a DynamoDB data source configuration.

Class ElasticsearchDataSourceConfig

Describes an Elasticsearch data source configuration.

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

AppSync exception

Class HttpDataSourceConfig

Describes a Http data source configuration.

Class InternalFailureException

AppSync exception

Class LambdaDataSourceConfig

Describes a Lambda data source configuration.

Class LimitExceededException

AppSync exception

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

AppSync exception

Class OpenIDConnectConfig

Describes an Open Id Connect 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 Type

Describes a type.

Class UnauthorizedException

AppSync exception

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