AppSync class

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

Constructors

AppSync({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createApiCache({required ApiCachingBehavior apiCachingBehavior, required String apiId, required int ttl, required ApiCacheType type, bool? atRestEncryptionEnabled, bool? transitEncryptionEnabled}) → Future<CreateApiCacheResponse>
Creates a cache for the GraphQL API.
createApiKey({required String apiId, String? description, int? expires}) → Future<CreateApiKeyResponse>
Creates a unique key that you can distribute to clients who are executing your API.
createDataSource({required String apiId, required String name, required DataSourceType type, String? description, DynamodbDataSourceConfig? dynamodbConfig, ElasticsearchDataSourceConfig? elasticsearchConfig, HttpDataSourceConfig? httpConfig, LambdaDataSourceConfig? lambdaConfig, RelationalDatabaseDataSourceConfig? relationalDatabaseConfig, String? serviceRoleArn}) → Future<CreateDataSourceResponse>
Creates a DataSource object.
createFunction({required String apiId, required String dataSourceName, required String functionVersion, required String name, String? description, String? requestMappingTemplate, String? responseMappingTemplate}) → Future<CreateFunctionResponse>
Creates a Function object.
createGraphqlApi({required AuthenticationType authenticationType, required String name, List<AdditionalAuthenticationProvider>? additionalAuthenticationProviders, LogConfig? logConfig, OpenIDConnectConfig? openIDConnectConfig, Map<String, String>? tags, UserPoolConfig? userPoolConfig, bool? xrayEnabled}) → Future<CreateGraphqlApiResponse>
Creates a GraphqlApi object.
createResolver({required String apiId, required String fieldName, required String typeName, CachingConfig? cachingConfig, String? dataSourceName, ResolverKind? kind, PipelineConfig? pipelineConfig, String? requestMappingTemplate, String? responseMappingTemplate, SyncConfig? syncConfig}) → Future<CreateResolverResponse>
Creates a Resolver object.
createType({required String apiId, required String definition, required TypeDefinitionFormat format}) → Future<CreateTypeResponse>
Creates a Type object.
deleteApiCache({required String apiId}) → Future<void>
Deletes an ApiCache object.
deleteApiKey({required String apiId, required String id}) → Future<void>
Deletes an API key.
deleteDataSource({required String apiId, required String name}) → Future<void>
Deletes a DataSource object.
deleteFunction({required String apiId, required String functionId}) → Future<void>
Deletes a Function.
deleteGraphqlApi({required String apiId}) → Future<void>
Deletes a GraphqlApi object.
deleteResolver({required String apiId, required String fieldName, required String typeName}) → Future<void>
Deletes a Resolver object.
deleteType({required String apiId, required String typeName}) → Future<void>
Deletes a Type object.
flushApiCache({required String apiId}) → Future<void>
Flushes an ApiCache object.
getApiCache({required String apiId}) → Future<GetApiCacheResponse>
Retrieves an ApiCache object.
getDataSource({required String apiId, required String name}) → Future<GetDataSourceResponse>
Retrieves a DataSource object.
getFunction({required String apiId, required String functionId}) → Future<GetFunctionResponse>
Get a Function.
getGraphqlApi({required String apiId}) → Future<GetGraphqlApiResponse>
Retrieves a GraphqlApi object.
getIntrospectionSchema({required String apiId, required OutputType format, bool? includeDirectives}) → Future<GetIntrospectionSchemaResponse>
Retrieves the introspection schema for a GraphQL API.
getResolver({required String apiId, required String fieldName, required String typeName}) → Future<GetResolverResponse>
Retrieves a Resolver object.
getSchemaCreationStatus({required String apiId}) → Future<GetSchemaCreationStatusResponse>
Retrieves the current status of a schema creation operation.
getType({required String apiId, required TypeDefinitionFormat format, required String typeName}) → Future<GetTypeResponse>
Retrieves a Type object.
listApiKeys({required String apiId, int? maxResults, String? nextToken}) → Future<ListApiKeysResponse>
Lists the API keys for a given API.
listDataSources({required String apiId, int? maxResults, String? nextToken}) → Future<ListDataSourcesResponse>
Lists the data sources for a given API.
listFunctions({required String apiId, int? maxResults, String? nextToken}) → Future<ListFunctionsResponse>
List multiple functions.
listGraphqlApis({int? maxResults, String? nextToken}) → Future<ListGraphqlApisResponse>
Lists your GraphQL APIs.
listResolvers({required String apiId, required String typeName, int? maxResults, String? nextToken}) → Future<ListResolversResponse>
Lists the resolvers for a given API and type.
listResolversByFunction({required String apiId, required String functionId, int? maxResults, String? nextToken}) → Future<ListResolversByFunctionResponse>
List the resolvers that are associated with a specific function.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists the tags for a resource.
listTypes({required String apiId, required TypeDefinitionFormat format, int? maxResults, String? nextToken}) → Future<ListTypesResponse>
Lists the types for a given API.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
startSchemaCreation({required String apiId, required Uint8List definition}) → Future<StartSchemaCreationResponse>
Adds a new schema to your GraphQL API.
tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>
Tags a resource with user-supplied tags.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Untags a resource.
updateApiCache({required ApiCachingBehavior apiCachingBehavior, required String apiId, required int ttl, required ApiCacheType type}) → Future<UpdateApiCacheResponse>
Updates the cache for the GraphQL API.
updateApiKey({required String apiId, required String id, String? description, int? expires}) → Future<UpdateApiKeyResponse>
Updates an API key. The key can be updated while it is not deleted.
updateDataSource({required String apiId, required String name, required DataSourceType type, String? description, DynamodbDataSourceConfig? dynamodbConfig, ElasticsearchDataSourceConfig? elasticsearchConfig, HttpDataSourceConfig? httpConfig, LambdaDataSourceConfig? lambdaConfig, RelationalDatabaseDataSourceConfig? relationalDatabaseConfig, String? serviceRoleArn}) → Future<UpdateDataSourceResponse>
Updates a DataSource object.
updateFunction({required String apiId, required String dataSourceName, required String functionId, required String functionVersion, required String name, String? description, String? requestMappingTemplate, String? responseMappingTemplate}) → Future<UpdateFunctionResponse>
Updates a Function object.
updateGraphqlApi({required String apiId, required String name, List<AdditionalAuthenticationProvider>? additionalAuthenticationProviders, AuthenticationType? authenticationType, LogConfig? logConfig, OpenIDConnectConfig? openIDConnectConfig, UserPoolConfig? userPoolConfig, bool? xrayEnabled}) → Future<UpdateGraphqlApiResponse>
Updates a GraphqlApi object.
updateResolver({required String apiId, required String fieldName, required String typeName, CachingConfig? cachingConfig, String? dataSourceName, ResolverKind? kind, PipelineConfig? pipelineConfig, String? requestMappingTemplate, String? responseMappingTemplate, SyncConfig? syncConfig}) → Future<UpdateResolverResponse>
Updates a Resolver object.
updateType({required String apiId, required TypeDefinitionFormat format, required String typeName, String? definition}) → Future<UpdateTypeResponse>
Updates a Type object.

Operators

operator ==(Object other) → bool
The equality operator.
inherited