View on GitHub
AppSync Structure Reference
AppSync
public struct AppSyncClient object for interacting with AWS AppSync service.
AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the AppSync client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Creates a cache for the GraphQL API.
Declaration
Swift
public func createApiCache(_ input: CreateApiCacheRequest) -> EventLoopFuture<CreateApiCacheResponse> -
Creates a unique key that you can distribute to clients who are executing your API.
Declaration
Swift
public func createApiKey(_ input: CreateApiKeyRequest) -> EventLoopFuture<CreateApiKeyResponse> -
Creates a DataSource object.
Declaration
Swift
public func createDataSource(_ input: CreateDataSourceRequest) -> EventLoopFuture<CreateDataSourceResponse> -
Creates a Function object. A function is a reusable entity. Multiple functions can be used to compose the resolver logic.
Declaration
Swift
public func createFunction(_ input: CreateFunctionRequest) -> EventLoopFuture<CreateFunctionResponse> -
Creates a GraphqlApi object.
Declaration
Swift
public func createGraphqlApi(_ input: CreateGraphqlApiRequest) -> EventLoopFuture<CreateGraphqlApiResponse> -
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.
Declaration
Swift
public func createResolver(_ input: CreateResolverRequest) -> EventLoopFuture<CreateResolverResponse> -
Creates a Type object.
Declaration
Swift
public func createType(_ input: CreateTypeRequest) -> EventLoopFuture<CreateTypeResponse> -
Deletes an ApiCache object.
Declaration
Swift
public func deleteApiCache(_ input: DeleteApiCacheRequest) -> EventLoopFuture<DeleteApiCacheResponse> -
Deletes an API key.
Declaration
Swift
public func deleteApiKey(_ input: DeleteApiKeyRequest) -> EventLoopFuture<DeleteApiKeyResponse> -
Deletes a DataSource object.
Declaration
Swift
public func deleteDataSource(_ input: DeleteDataSourceRequest) -> EventLoopFuture<DeleteDataSourceResponse> -
Deletes a Function.
Declaration
Swift
public func deleteFunction(_ input: DeleteFunctionRequest) -> EventLoopFuture<DeleteFunctionResponse> -
Deletes a GraphqlApi object.
Declaration
Swift
public func deleteGraphqlApi(_ input: DeleteGraphqlApiRequest) -> EventLoopFuture<DeleteGraphqlApiResponse> -
Deletes a Resolver object.
Declaration
Swift
public func deleteResolver(_ input: DeleteResolverRequest) -> EventLoopFuture<DeleteResolverResponse> -
Deletes a Type object.
Declaration
Swift
public func deleteType(_ input: DeleteTypeRequest) -> EventLoopFuture<DeleteTypeResponse> -
Flushes an ApiCache object.
Declaration
Swift
public func flushApiCache(_ input: FlushApiCacheRequest) -> EventLoopFuture<FlushApiCacheResponse> -
Retrieves an ApiCache object.
Declaration
Swift
public func getApiCache(_ input: GetApiCacheRequest) -> EventLoopFuture<GetApiCacheResponse> -
Retrieves a DataSource object.
Declaration
Swift
public func getDataSource(_ input: GetDataSourceRequest) -> EventLoopFuture<GetDataSourceResponse> -
Get a Function.
Declaration
Swift
public func getFunction(_ input: GetFunctionRequest) -> EventLoopFuture<GetFunctionResponse> -
Retrieves a GraphqlApi object.
Declaration
Swift
public func getGraphqlApi(_ input: GetGraphqlApiRequest) -> EventLoopFuture<GetGraphqlApiResponse> -
Retrieves the introspection schema for a GraphQL API.
Declaration
Swift
public func getIntrospectionSchema(_ input: GetIntrospectionSchemaRequest) -> EventLoopFuture<GetIntrospectionSchemaResponse> -
Retrieves a Resolver object.
Declaration
Swift
public func getResolver(_ input: GetResolverRequest) -> EventLoopFuture<GetResolverResponse> -
Retrieves the current status of a schema creation operation.
Declaration
Swift
public func getSchemaCreationStatus(_ input: GetSchemaCreationStatusRequest) -> EventLoopFuture<GetSchemaCreationStatusResponse> -
Retrieves a Type object.
Declaration
Swift
public func getType(_ input: GetTypeRequest) -> EventLoopFuture<GetTypeResponse> -
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.
Declaration
Swift
public func listApiKeys(_ input: ListApiKeysRequest) -> EventLoopFuture<ListApiKeysResponse> -
Lists the data sources for a given API.
Declaration
Swift
public func listDataSources(_ input: ListDataSourcesRequest) -> EventLoopFuture<ListDataSourcesResponse> -
List multiple functions.
Declaration
Swift
public func listFunctions(_ input: ListFunctionsRequest) -> EventLoopFuture<ListFunctionsResponse> -
Lists your GraphQL APIs.
Declaration
Swift
public func listGraphqlApis(_ input: ListGraphqlApisRequest) -> EventLoopFuture<ListGraphqlApisResponse> -
Lists the resolvers for a given API and type.
Declaration
Swift
public func listResolvers(_ input: ListResolversRequest) -> EventLoopFuture<ListResolversResponse> -
List the resolvers that are associated with a specific function.
Declaration
Swift
public func listResolversByFunction(_ input: ListResolversByFunctionRequest) -> EventLoopFuture<ListResolversByFunctionResponse> -
Lists the tags for a resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
Lists the types for a given API.
Declaration
Swift
public func listTypes(_ input: ListTypesRequest) -> EventLoopFuture<ListTypesResponse> -
Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed.
Declaration
Swift
public func startSchemaCreation(_ input: StartSchemaCreationRequest) -> EventLoopFuture<StartSchemaCreationResponse> -
Tags a resource with user-supplied tags.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse> -
Untags a resource.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse> -
Updates the cache for the GraphQL API.
Declaration
Swift
public func updateApiCache(_ input: UpdateApiCacheRequest) -> EventLoopFuture<UpdateApiCacheResponse> -
Updates an API key.
Declaration
Swift
public func updateApiKey(_ input: UpdateApiKeyRequest) -> EventLoopFuture<UpdateApiKeyResponse> -
Updates a DataSource object.
Declaration
Swift
public func updateDataSource(_ input: UpdateDataSourceRequest) -> EventLoopFuture<UpdateDataSourceResponse> -
Updates a Function object.
Declaration
Swift
public func updateFunction(_ input: UpdateFunctionRequest) -> EventLoopFuture<UpdateFunctionResponse> -
Updates a GraphqlApi object.
Declaration
Swift
public func updateGraphqlApi(_ input: UpdateGraphqlApiRequest) -> EventLoopFuture<UpdateGraphqlApiResponse> -
Updates a Resolver object.
Declaration
Swift
public func updateResolver(_ input: UpdateResolverRequest) -> EventLoopFuture<UpdateResolverResponse> -
Updates a Type object.
Declaration
Swift
public func updateType(_ input: UpdateTypeRequest) -> EventLoopFuture<UpdateTypeResponse>
-
Undocumented
See moreDeclaration
Swift
public enum ApiCacheStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ApiCacheType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ApiCachingBehavior : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum AuthenticationType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum AuthorizationType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ConflictDetectionType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ConflictHandlerType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DataSourceType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DefaultAction : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum FieldLogLevel : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum OutputType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RelationalDatabaseSourceType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ResolverKind : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum SchemaStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum TypeDefinitionFormat : String, CustomStringConvertible, Codable