Expand description
AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
If you’re using the service, you’re probably looking for AppSyncClient and AppSync.
Structs§
- Additional
Authentication Provider Describes an additional authentication provider.
- ApiCache
The
ApiCacheobject.- 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.
-
ListApiKeysreturns the expiration time in milliseconds. -
CreateApiKeyreturns the expiration time in milliseconds. -
UpdateApiKeyis not available for this key version. -
DeleteApiKeydeletes 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.
-
ListApiKeysreturns the expiration time and deletion time in seconds. -
CreateApiKeyreturns the expiration time and deletion time in seconds and accepts a user-provided expiration time in seconds. -
UpdateApiKeyreturns the expiration time and and deletion time in seconds and accepts a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration time. Key expiration time can be updated while the key is not deleted. -
DeleteApiKeydeletes the item from the table. -
Expiration is stored in Amazon DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. But the key can be reinstated before deletion.
-
Deletion is stored in Amazon DynamoDB as seconds. The key will be deleted after deletion time.
-
- AppSync
Client - A client for the AWSAppSync API.
- Authorization
Config The authorization config in case the HTTP endpoint requires authorization.
- AwsIam
Config The AWS IAM configuration.
- Caching
Config The caching configuration for a resolver that has caching enabled.
- Cognito
User Pool Config Describes an Amazon Cognito user pool configuration.
- Create
ApiCache Request Represents the input of a
CreateApiCacheoperation.- Create
ApiCache Response Represents the output of a
CreateApiCacheoperation.- Create
ApiKey Request - Create
ApiKey Response - Create
Data Source Request - Create
Data Source Response - Create
Function Request - Create
Function Response - Create
Graphql ApiRequest - Create
Graphql ApiResponse - Create
Resolver Request - Create
Resolver Response - Create
Type Request - Create
Type Response - Data
Source Describes a data source.
- Delete
ApiCache Request Represents the input of a
DeleteApiCacheoperation.- Delete
ApiCache Response Represents the output of a
DeleteApiCacheoperation.- Delete
ApiKey Request - Delete
ApiKey Response - Delete
Data Source Request - Delete
Data Source Response - Delete
Function Request - Delete
Function Response - Delete
Graphql ApiRequest - Delete
Graphql ApiResponse - Delete
Resolver Request - Delete
Resolver Response - Delete
Type Request - Delete
Type Response - Delta
Sync Config Describes a Delta Sync configuration.
- Dynamodb
Data Source Config Describes an Amazon DynamoDB data source configuration.
- Elasticsearch
Data Source Config Describes an Elasticsearch data source configuration.
- Flush
ApiCache Request Represents the input of a
FlushApiCacheoperation.- Flush
ApiCache Response Represents the output of a
FlushApiCacheoperation.- Function
Configuration A function is a reusable entity. Multiple functions can be used to compose the resolver logic.
- GetApi
Cache Request Represents the input of a
GetApiCacheoperation.- GetApi
Cache Response Represents the output of a
GetApiCacheoperation.- GetData
Source Request - GetData
Source Response - GetFunction
Request - GetFunction
Response - GetGraphql
ApiRequest - GetGraphql
ApiResponse - GetIntrospection
Schema Request - GetIntrospection
Schema Response - GetResolver
Request - GetResolver
Response - GetSchema
Creation Status Request - GetSchema
Creation Status Response - GetType
Request - GetType
Response - Graphql
Api Describes a GraphQL API.
- Http
Data Source Config Describes an HTTP data source configuration.
- Lambda
Conflict Handler Config The
LambdaConflictHandlerConfigobject when configuring LAMBDA as the Conflict Handler.- Lambda
Data Source Config Describes an AWS Lambda data source configuration.
- List
ApiKeys Request - List
ApiKeys Response - List
Data Sources Request - List
Data Sources Response - List
Functions Request - List
Functions Response - List
Graphql Apis Request - List
Graphql Apis Response - List
Resolvers ByFunction Request - List
Resolvers ByFunction Response - List
Resolvers Request - List
Resolvers Response - List
Tags ForResource Request - List
Tags ForResource Response - List
Types Request - List
Types Response - LogConfig
The CloudWatch Logs configuration.
- OpenID
Connect Config Describes an OpenID Connect configuration.
- Pipeline
Config The pipeline configuration for a resolver of kind
PIPELINE.- RdsHttp
Endpoint Config The Amazon RDS HTTP endpoint configuration.
- Relational
Database Data Source Config Describes a relational database data source configuration.
- Resolver
Describes a resolver.
- Start
Schema Creation Request - Start
Schema Creation Response - Sync
Config 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.
- TagResource
Request - TagResource
Response - Type
Describes a type.
- Untag
Resource Request - Untag
Resource Response - Update
ApiCache Request Represents the input of a
UpdateApiCacheoperation.- Update
ApiCache Response Represents the output of a
UpdateApiCacheoperation.- Update
ApiKey Request - Update
ApiKey Response - Update
Data Source Request - Update
Data Source Response - Update
Function Request - Update
Function Response - Update
Graphql ApiRequest - Update
Graphql ApiResponse - Update
Resolver Request - Update
Resolver Response - Update
Type Request - Update
Type Response - User
Pool Config Describes an Amazon Cognito user pool configuration.
Enums§
- Create
ApiCache Error - Errors returned by CreateApiCache
- Create
ApiKey Error - Errors returned by CreateApiKey
- Create
Data Source Error - Errors returned by CreateDataSource
- Create
Function Error - Errors returned by CreateFunction
- Create
Graphql ApiError - Errors returned by CreateGraphqlApi
- Create
Resolver Error - Errors returned by CreateResolver
- Create
Type Error - Errors returned by CreateType
- Delete
ApiCache Error - Errors returned by DeleteApiCache
- Delete
ApiKey Error - Errors returned by DeleteApiKey
- Delete
Data Source Error - Errors returned by DeleteDataSource
- Delete
Function Error - Errors returned by DeleteFunction
- Delete
Graphql ApiError - Errors returned by DeleteGraphqlApi
- Delete
Resolver Error - Errors returned by DeleteResolver
- Delete
Type Error - Errors returned by DeleteType
- Flush
ApiCache Error - Errors returned by FlushApiCache
- GetApi
Cache Error - Errors returned by GetApiCache
- GetData
Source Error - Errors returned by GetDataSource
- GetFunction
Error - Errors returned by GetFunction
- GetGraphql
ApiError - Errors returned by GetGraphqlApi
- GetIntrospection
Schema Error - Errors returned by GetIntrospectionSchema
- GetResolver
Error - Errors returned by GetResolver
- GetSchema
Creation Status Error - Errors returned by GetSchemaCreationStatus
- GetType
Error - Errors returned by GetType
- List
ApiKeys Error - Errors returned by ListApiKeys
- List
Data Sources Error - Errors returned by ListDataSources
- List
Functions Error - Errors returned by ListFunctions
- List
Graphql Apis Error - Errors returned by ListGraphqlApis
- List
Resolvers ByFunction Error - Errors returned by ListResolversByFunction
- List
Resolvers Error - Errors returned by ListResolvers
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Types Error - Errors returned by ListTypes
- Start
Schema Creation Error - Errors returned by StartSchemaCreation
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
ApiCache Error - Errors returned by UpdateApiCache
- Update
ApiKey Error - Errors returned by UpdateApiKey
- Update
Data Source Error - Errors returned by UpdateDataSource
- Update
Function Error - Errors returned by UpdateFunction
- Update
Graphql ApiError - Errors returned by UpdateGraphqlApi
- Update
Resolver Error - Errors returned by UpdateResolver
- Update
Type Error - Errors returned by UpdateType
Traits§
- AppSync
- Trait representing the capabilities of the AWSAppSync API. AWSAppSync clients implement this trait.