@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSAppSyncAsync extends AWSAppSync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSAppSyncAsync instead.
AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
ENDPOINT_PREFIXassociateApi, associateMergedGraphqlApi, associateSourceGraphqlApi, createApiCache, createApiKey, createDataSource, createDomainName, createFunction, createGraphqlApi, createResolver, createType, deleteApiCache, deleteApiKey, deleteDataSource, deleteDomainName, deleteFunction, deleteGraphqlApi, deleteResolver, deleteType, disassociateApi, disassociateMergedGraphqlApi, disassociateSourceGraphqlApi, evaluateCode, evaluateMappingTemplate, flushApiCache, getApiAssociation, getApiCache, getCachedResponseMetadata, getDataSource, getDataSourceIntrospection, getDomainName, getFunction, getGraphqlApi, getGraphqlApiEnvironmentVariables, getIntrospectionSchema, getResolver, getSchemaCreationStatus, getSourceApiAssociation, getType, listApiKeys, listDataSources, listDomainNames, listFunctions, listGraphqlApis, listResolvers, listResolversByFunction, listSourceApiAssociations, listTagsForResource, listTypes, listTypesByAssociation, putGraphqlApiEnvironmentVariables, shutdown, startDataSourceIntrospection, startSchemaCreation, startSchemaMerge, tagResource, untagResource, updateApiCache, updateApiKey, updateDataSource, updateDomainName, updateFunction, updateGraphqlApi, updateResolver, updateSourceApiAssociation, updateTypeFuture<AssociateApiResult> associateApiAsync(AssociateApiRequest associateApiRequest)
Maps an endpoint to your custom domain.
associateApiRequest - Future<AssociateApiResult> associateApiAsync(AssociateApiRequest associateApiRequest, AsyncHandler<AssociateApiRequest,AssociateApiResult> asyncHandler)
Maps an endpoint to your custom domain.
associateApiRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AssociateMergedGraphqlApiResult> associateMergedGraphqlApiAsync(AssociateMergedGraphqlApiRequest associateMergedGraphqlApiRequest)
Creates an association between a Merged API and source API using the source API's identifier.
associateMergedGraphqlApiRequest - Future<AssociateMergedGraphqlApiResult> associateMergedGraphqlApiAsync(AssociateMergedGraphqlApiRequest associateMergedGraphqlApiRequest, AsyncHandler<AssociateMergedGraphqlApiRequest,AssociateMergedGraphqlApiResult> asyncHandler)
Creates an association between a Merged API and source API using the source API's identifier.
associateMergedGraphqlApiRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AssociateSourceGraphqlApiResult> associateSourceGraphqlApiAsync(AssociateSourceGraphqlApiRequest associateSourceGraphqlApiRequest)
Creates an association between a Merged API and source API using the Merged API's identifier.
associateSourceGraphqlApiRequest - Future<AssociateSourceGraphqlApiResult> associateSourceGraphqlApiAsync(AssociateSourceGraphqlApiRequest associateSourceGraphqlApiRequest, AsyncHandler<AssociateSourceGraphqlApiRequest,AssociateSourceGraphqlApiResult> asyncHandler)
Creates an association between a Merged API and source API using the Merged API's identifier.
associateSourceGraphqlApiRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateApiCacheResult> createApiCacheAsync(CreateApiCacheRequest createApiCacheRequest)
Creates a cache for the GraphQL API.
createApiCacheRequest - Represents the input of a CreateApiCache operation.Future<CreateApiCacheResult> createApiCacheAsync(CreateApiCacheRequest createApiCacheRequest, AsyncHandler<CreateApiCacheRequest,CreateApiCacheResult> asyncHandler)
Creates a cache for the GraphQL API.
createApiCacheRequest - Represents the input of a CreateApiCache operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateApiKeyResult> createApiKeyAsync(CreateApiKeyRequest createApiKeyRequest)
Creates a unique key that you can distribute to clients who invoke your API.
createApiKeyRequest - Future<CreateApiKeyResult> createApiKeyAsync(CreateApiKeyRequest createApiKeyRequest, AsyncHandler<CreateApiKeyRequest,CreateApiKeyResult> asyncHandler)
Creates a unique key that you can distribute to clients who invoke your API.
createApiKeyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest)
Creates a DataSource object.
createDataSourceRequest - Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResult> asyncHandler)
Creates a DataSource object.
createDataSourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDomainNameResult> createDomainNameAsync(CreateDomainNameRequest createDomainNameRequest)
Creates a custom DomainName object.
createDomainNameRequest - Future<CreateDomainNameResult> createDomainNameAsync(CreateDomainNameRequest createDomainNameRequest, AsyncHandler<CreateDomainNameRequest,CreateDomainNameResult> asyncHandler)
Creates a custom DomainName object.
createDomainNameRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateFunctionResult> createFunctionAsync(CreateFunctionRequest createFunctionRequest)
Creates a Function object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
createFunctionRequest - Future<CreateFunctionResult> createFunctionAsync(CreateFunctionRequest createFunctionRequest, AsyncHandler<CreateFunctionRequest,CreateFunctionResult> asyncHandler)
Creates a Function object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
createFunctionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateGraphqlApiResult> createGraphqlApiAsync(CreateGraphqlApiRequest createGraphqlApiRequest)
Creates a GraphqlApi object.
createGraphqlApiRequest - Future<CreateGraphqlApiResult> createGraphqlApiAsync(CreateGraphqlApiRequest createGraphqlApiRequest, AsyncHandler<CreateGraphqlApiRequest,CreateGraphqlApiResult> asyncHandler)
Creates a GraphqlApi object.
createGraphqlApiRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateResolverResult> createResolverAsync(CreateResolverRequest createResolverRequest)
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.
createResolverRequest - Future<CreateResolverResult> createResolverAsync(CreateResolverRequest createResolverRequest, AsyncHandler<CreateResolverRequest,CreateResolverResult> asyncHandler)
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.
createResolverRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateTypeResult> createTypeAsync(CreateTypeRequest createTypeRequest)
Creates a Type object.
createTypeRequest - Future<CreateTypeResult> createTypeAsync(CreateTypeRequest createTypeRequest, AsyncHandler<CreateTypeRequest,CreateTypeResult> asyncHandler)
Creates a Type object.
createTypeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteApiCacheResult> deleteApiCacheAsync(DeleteApiCacheRequest deleteApiCacheRequest)
Deletes an ApiCache object.
deleteApiCacheRequest - Represents the input of a DeleteApiCache operation.Future<DeleteApiCacheResult> deleteApiCacheAsync(DeleteApiCacheRequest deleteApiCacheRequest, AsyncHandler<DeleteApiCacheRequest,DeleteApiCacheResult> asyncHandler)
Deletes an ApiCache object.
deleteApiCacheRequest - Represents the input of a DeleteApiCache operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteApiKeyResult> deleteApiKeyAsync(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes an API key.
deleteApiKeyRequest - Future<DeleteApiKeyResult> deleteApiKeyAsync(DeleteApiKeyRequest deleteApiKeyRequest, AsyncHandler<DeleteApiKeyRequest,DeleteApiKeyResult> asyncHandler)
Deletes an API key.
deleteApiKeyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes a DataSource object.
deleteDataSourceRequest - Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResult> asyncHandler)
Deletes a DataSource object.
deleteDataSourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDomainNameResult> deleteDomainNameAsync(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes a custom DomainName object.
deleteDomainNameRequest - Future<DeleteDomainNameResult> deleteDomainNameAsync(DeleteDomainNameRequest deleteDomainNameRequest, AsyncHandler<DeleteDomainNameRequest,DeleteDomainNameResult> asyncHandler)
Deletes a custom DomainName object.
deleteDomainNameRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteFunctionResult> deleteFunctionAsync(DeleteFunctionRequest deleteFunctionRequest)
Deletes a Function.
deleteFunctionRequest - Future<DeleteFunctionResult> deleteFunctionAsync(DeleteFunctionRequest deleteFunctionRequest, AsyncHandler<DeleteFunctionRequest,DeleteFunctionResult> asyncHandler)
Deletes a Function.
deleteFunctionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteGraphqlApiResult> deleteGraphqlApiAsync(DeleteGraphqlApiRequest deleteGraphqlApiRequest)
Deletes a GraphqlApi object.
deleteGraphqlApiRequest - Future<DeleteGraphqlApiResult> deleteGraphqlApiAsync(DeleteGraphqlApiRequest deleteGraphqlApiRequest, AsyncHandler<DeleteGraphqlApiRequest,DeleteGraphqlApiResult> asyncHandler)
Deletes a GraphqlApi object.
deleteGraphqlApiRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteResolverResult> deleteResolverAsync(DeleteResolverRequest deleteResolverRequest)
Deletes a Resolver object.
deleteResolverRequest - Future<DeleteResolverResult> deleteResolverAsync(DeleteResolverRequest deleteResolverRequest, AsyncHandler<DeleteResolverRequest,DeleteResolverResult> asyncHandler)
Deletes a Resolver object.
deleteResolverRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteTypeResult> deleteTypeAsync(DeleteTypeRequest deleteTypeRequest)
Deletes a Type object.
deleteTypeRequest - Future<DeleteTypeResult> deleteTypeAsync(DeleteTypeRequest deleteTypeRequest, AsyncHandler<DeleteTypeRequest,DeleteTypeResult> asyncHandler)
Deletes a Type object.
deleteTypeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateApiResult> disassociateApiAsync(DisassociateApiRequest disassociateApiRequest)
Removes an ApiAssociation object from a custom domain.
disassociateApiRequest - Future<DisassociateApiResult> disassociateApiAsync(DisassociateApiRequest disassociateApiRequest, AsyncHandler<DisassociateApiRequest,DisassociateApiResult> asyncHandler)
Removes an ApiAssociation object from a custom domain.
disassociateApiRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateMergedGraphqlApiResult> disassociateMergedGraphqlApiAsync(DisassociateMergedGraphqlApiRequest disassociateMergedGraphqlApiRequest)
Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
disassociateMergedGraphqlApiRequest - Future<DisassociateMergedGraphqlApiResult> disassociateMergedGraphqlApiAsync(DisassociateMergedGraphqlApiRequest disassociateMergedGraphqlApiRequest, AsyncHandler<DisassociateMergedGraphqlApiRequest,DisassociateMergedGraphqlApiResult> asyncHandler)
Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
disassociateMergedGraphqlApiRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateSourceGraphqlApiResult> disassociateSourceGraphqlApiAsync(DisassociateSourceGraphqlApiRequest disassociateSourceGraphqlApiRequest)
Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
disassociateSourceGraphqlApiRequest - Future<DisassociateSourceGraphqlApiResult> disassociateSourceGraphqlApiAsync(DisassociateSourceGraphqlApiRequest disassociateSourceGraphqlApiRequest, AsyncHandler<DisassociateSourceGraphqlApiRequest,DisassociateSourceGraphqlApiResult> asyncHandler)
Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
disassociateSourceGraphqlApiRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EvaluateCodeResult> evaluateCodeAsync(EvaluateCodeRequest evaluateCodeRequest)
Evaluates the given code and returns the response. The code definition requirements depend on the specified
runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request
function takes the incoming request after a GraphQL operation is parsed and converts it into a request
configuration for the selected data source operation. The response function interprets responses from the data
source and maps it to the shape of the GraphQL field output type.
evaluateCodeRequest - Future<EvaluateCodeResult> evaluateCodeAsync(EvaluateCodeRequest evaluateCodeRequest, AsyncHandler<EvaluateCodeRequest,EvaluateCodeResult> asyncHandler)
Evaluates the given code and returns the response. The code definition requirements depend on the specified
runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request
function takes the incoming request after a GraphQL operation is parsed and converts it into a request
configuration for the selected data source operation. The response function interprets responses from the data
source and maps it to the shape of the GraphQL field output type.
evaluateCodeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EvaluateMappingTemplateResult> evaluateMappingTemplateAsync(EvaluateMappingTemplateRequest evaluateMappingTemplateRequest)
Evaluates a given template and returns the response. The mapping template can be a request or response template.
Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type.
Mapping templates are written in the Apache Velocity Template Language (VTL).
evaluateMappingTemplateRequest - Future<EvaluateMappingTemplateResult> evaluateMappingTemplateAsync(EvaluateMappingTemplateRequest evaluateMappingTemplateRequest, AsyncHandler<EvaluateMappingTemplateRequest,EvaluateMappingTemplateResult> asyncHandler)
Evaluates a given template and returns the response. The mapping template can be a request or response template.
Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type.
Mapping templates are written in the Apache Velocity Template Language (VTL).
evaluateMappingTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<FlushApiCacheResult> flushApiCacheAsync(FlushApiCacheRequest flushApiCacheRequest)
Flushes an ApiCache object.
flushApiCacheRequest - Represents the input of a FlushApiCache operation.Future<FlushApiCacheResult> flushApiCacheAsync(FlushApiCacheRequest flushApiCacheRequest, AsyncHandler<FlushApiCacheRequest,FlushApiCacheResult> asyncHandler)
Flushes an ApiCache object.
flushApiCacheRequest - Represents the input of a FlushApiCache operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetApiAssociationResult> getApiAssociationAsync(GetApiAssociationRequest getApiAssociationRequest)
Retrieves an ApiAssociation object.
getApiAssociationRequest - Future<GetApiAssociationResult> getApiAssociationAsync(GetApiAssociationRequest getApiAssociationRequest, AsyncHandler<GetApiAssociationRequest,GetApiAssociationResult> asyncHandler)
Retrieves an ApiAssociation object.
getApiAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetApiCacheResult> getApiCacheAsync(GetApiCacheRequest getApiCacheRequest)
Retrieves an ApiCache object.
getApiCacheRequest - Represents the input of a GetApiCache operation.Future<GetApiCacheResult> getApiCacheAsync(GetApiCacheRequest getApiCacheRequest, AsyncHandler<GetApiCacheRequest,GetApiCacheResult> asyncHandler)
Retrieves an ApiCache object.
getApiCacheRequest - Represents the input of a GetApiCache operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDataSourceResult> getDataSourceAsync(GetDataSourceRequest getDataSourceRequest)
Retrieves a DataSource object.
getDataSourceRequest - Future<GetDataSourceResult> getDataSourceAsync(GetDataSourceRequest getDataSourceRequest, AsyncHandler<GetDataSourceRequest,GetDataSourceResult> asyncHandler)
Retrieves a DataSource object.
getDataSourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDataSourceIntrospectionResult> getDataSourceIntrospectionAsync(GetDataSourceIntrospectionRequest getDataSourceIntrospectionRequest)
Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.
getDataSourceIntrospectionRequest - Future<GetDataSourceIntrospectionResult> getDataSourceIntrospectionAsync(GetDataSourceIntrospectionRequest getDataSourceIntrospectionRequest, AsyncHandler<GetDataSourceIntrospectionRequest,GetDataSourceIntrospectionResult> asyncHandler)
Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.
getDataSourceIntrospectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDomainNameResult> getDomainNameAsync(GetDomainNameRequest getDomainNameRequest)
Retrieves a custom DomainName object.
getDomainNameRequest - Future<GetDomainNameResult> getDomainNameAsync(GetDomainNameRequest getDomainNameRequest, AsyncHandler<GetDomainNameRequest,GetDomainNameResult> asyncHandler)
Retrieves a custom DomainName object.
getDomainNameRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetFunctionResult> getFunctionAsync(GetFunctionRequest getFunctionRequest)
Get a Function.
getFunctionRequest - Future<GetFunctionResult> getFunctionAsync(GetFunctionRequest getFunctionRequest, AsyncHandler<GetFunctionRequest,GetFunctionResult> asyncHandler)
Get a Function.
getFunctionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetGraphqlApiResult> getGraphqlApiAsync(GetGraphqlApiRequest getGraphqlApiRequest)
Retrieves a GraphqlApi object.
getGraphqlApiRequest - Future<GetGraphqlApiResult> getGraphqlApiAsync(GetGraphqlApiRequest getGraphqlApiRequest, AsyncHandler<GetGraphqlApiRequest,GetGraphqlApiResult> asyncHandler)
Retrieves a GraphqlApi object.
getGraphqlApiRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetGraphqlApiEnvironmentVariablesResult> getGraphqlApiEnvironmentVariablesAsync(GetGraphqlApiEnvironmentVariablesRequest getGraphqlApiEnvironmentVariablesRequest)
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
getGraphqlApiEnvironmentVariablesRequest - Future<GetGraphqlApiEnvironmentVariablesResult> getGraphqlApiEnvironmentVariablesAsync(GetGraphqlApiEnvironmentVariablesRequest getGraphqlApiEnvironmentVariablesRequest, AsyncHandler<GetGraphqlApiEnvironmentVariablesRequest,GetGraphqlApiEnvironmentVariablesResult> asyncHandler)
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
getGraphqlApiEnvironmentVariablesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetIntrospectionSchemaResult> getIntrospectionSchemaAsync(GetIntrospectionSchemaRequest getIntrospectionSchemaRequest)
Retrieves the introspection schema for a GraphQL API.
getIntrospectionSchemaRequest - Future<GetIntrospectionSchemaResult> getIntrospectionSchemaAsync(GetIntrospectionSchemaRequest getIntrospectionSchemaRequest, AsyncHandler<GetIntrospectionSchemaRequest,GetIntrospectionSchemaResult> asyncHandler)
Retrieves the introspection schema for a GraphQL API.
getIntrospectionSchemaRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetResolverResult> getResolverAsync(GetResolverRequest getResolverRequest)
Retrieves a Resolver object.
getResolverRequest - Future<GetResolverResult> getResolverAsync(GetResolverRequest getResolverRequest, AsyncHandler<GetResolverRequest,GetResolverResult> asyncHandler)
Retrieves a Resolver object.
getResolverRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSchemaCreationStatusResult> getSchemaCreationStatusAsync(GetSchemaCreationStatusRequest getSchemaCreationStatusRequest)
Retrieves the current status of a schema creation operation.
getSchemaCreationStatusRequest - Future<GetSchemaCreationStatusResult> getSchemaCreationStatusAsync(GetSchemaCreationStatusRequest getSchemaCreationStatusRequest, AsyncHandler<GetSchemaCreationStatusRequest,GetSchemaCreationStatusResult> asyncHandler)
Retrieves the current status of a schema creation operation.
getSchemaCreationStatusRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSourceApiAssociationResult> getSourceApiAssociationAsync(GetSourceApiAssociationRequest getSourceApiAssociationRequest)
Retrieves a SourceApiAssociation object.
getSourceApiAssociationRequest - Future<GetSourceApiAssociationResult> getSourceApiAssociationAsync(GetSourceApiAssociationRequest getSourceApiAssociationRequest, AsyncHandler<GetSourceApiAssociationRequest,GetSourceApiAssociationResult> asyncHandler)
Retrieves a SourceApiAssociation object.
getSourceApiAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTypeResult> getTypeAsync(GetTypeRequest getTypeRequest)
Retrieves a Type object.
getTypeRequest - Future<GetTypeResult> getTypeAsync(GetTypeRequest getTypeRequest, AsyncHandler<GetTypeRequest,GetTypeResult> asyncHandler)
Retrieves a Type object.
getTypeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListApiKeysResult> listApiKeysAsync(ListApiKeysRequest listApiKeysRequest)
Lists the API keys for a given API.
API keys are deleted automatically 60 days 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.
listApiKeysRequest - Future<ListApiKeysResult> listApiKeysAsync(ListApiKeysRequest listApiKeysRequest, AsyncHandler<ListApiKeysRequest,ListApiKeysResult> asyncHandler)
Lists the API keys for a given API.
API keys are deleted automatically 60 days 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.
listApiKeysRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources for a given API.
listDataSourcesRequest - Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
Lists the data sources for a given API.
listDataSourcesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDomainNamesResult> listDomainNamesAsync(ListDomainNamesRequest listDomainNamesRequest)
Lists multiple custom domain names.
listDomainNamesRequest - Future<ListDomainNamesResult> listDomainNamesAsync(ListDomainNamesRequest listDomainNamesRequest, AsyncHandler<ListDomainNamesRequest,ListDomainNamesResult> asyncHandler)
Lists multiple custom domain names.
listDomainNamesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListFunctionsResult> listFunctionsAsync(ListFunctionsRequest listFunctionsRequest)
List multiple functions.
listFunctionsRequest - Future<ListFunctionsResult> listFunctionsAsync(ListFunctionsRequest listFunctionsRequest, AsyncHandler<ListFunctionsRequest,ListFunctionsResult> asyncHandler)
List multiple functions.
listFunctionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListGraphqlApisResult> listGraphqlApisAsync(ListGraphqlApisRequest listGraphqlApisRequest)
Lists your GraphQL APIs.
listGraphqlApisRequest - Future<ListGraphqlApisResult> listGraphqlApisAsync(ListGraphqlApisRequest listGraphqlApisRequest, AsyncHandler<ListGraphqlApisRequest,ListGraphqlApisResult> asyncHandler)
Lists your GraphQL APIs.
listGraphqlApisRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResolversResult> listResolversAsync(ListResolversRequest listResolversRequest)
Lists the resolvers for a given API and type.
listResolversRequest - Future<ListResolversResult> listResolversAsync(ListResolversRequest listResolversRequest, AsyncHandler<ListResolversRequest,ListResolversResult> asyncHandler)
Lists the resolvers for a given API and type.
listResolversRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResolversByFunctionResult> listResolversByFunctionAsync(ListResolversByFunctionRequest listResolversByFunctionRequest)
List the resolvers that are associated with a specific function.
listResolversByFunctionRequest - Future<ListResolversByFunctionResult> listResolversByFunctionAsync(ListResolversByFunctionRequest listResolversByFunctionRequest, AsyncHandler<ListResolversByFunctionRequest,ListResolversByFunctionResult> asyncHandler)
List the resolvers that are associated with a specific function.
listResolversByFunctionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListSourceApiAssociationsResult> listSourceApiAssociationsAsync(ListSourceApiAssociationsRequest listSourceApiAssociationsRequest)
Lists the SourceApiAssociationSummary data.
listSourceApiAssociationsRequest - Future<ListSourceApiAssociationsResult> listSourceApiAssociationsAsync(ListSourceApiAssociationsRequest listSourceApiAssociationsRequest, AsyncHandler<ListSourceApiAssociationsRequest,ListSourceApiAssociationsResult> asyncHandler)
Lists the SourceApiAssociationSummary data.
listSourceApiAssociationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for a resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags for a resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTypesResult> listTypesAsync(ListTypesRequest listTypesRequest)
Lists the types for a given API.
listTypesRequest - Future<ListTypesResult> listTypesAsync(ListTypesRequest listTypesRequest, AsyncHandler<ListTypesRequest,ListTypesResult> asyncHandler)
Lists the types for a given API.
listTypesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTypesByAssociationResult> listTypesByAssociationAsync(ListTypesByAssociationRequest listTypesByAssociationRequest)
Lists Type objects by the source API association ID.
listTypesByAssociationRequest - Future<ListTypesByAssociationResult> listTypesByAssociationAsync(ListTypesByAssociationRequest listTypesByAssociationRequest, AsyncHandler<ListTypesByAssociationRequest,ListTypesByAssociationResult> asyncHandler)
Lists Type objects by the source API association ID.
listTypesByAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutGraphqlApiEnvironmentVariablesResult> putGraphqlApiEnvironmentVariablesAsync(PutGraphqlApiEnvironmentVariablesRequest putGraphqlApiEnvironmentVariablesRequest)
Creates a list of environmental variables in an API by its ID value.
When creating an environmental variable, it must follow the constraints below:
Both JavaScript and VTL templates support environmental variables.
Environmental variables are not evaluated before function invocation.
Environmental variables only support string values.
Any defined value in an environmental variable is considered a string literal and not expanded.
Variable evaluations should ideally be performed in the function code.
When creating an environmental variable key-value pair, it must follow the additional constraints below:
Keys must begin with a letter.
Keys must be at least two characters long.
Keys can only contain letters, numbers, and the underscore character (_).
Values can be up to 512 characters long.
You can configure up to 50 key-value pairs in a GraphQL API.
You can create a list of environmental variables by adding it to the environmentVariables payload as
a list in the format {"key1":"value1","key2":"value2", …}. Note that each call of the
PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing
environmental variable list of that API. This means the existing environmental variables will be lost. To avoid
this, you must include all existing and new environmental variables in the list each time you call this action.
putGraphqlApiEnvironmentVariablesRequest - Future<PutGraphqlApiEnvironmentVariablesResult> putGraphqlApiEnvironmentVariablesAsync(PutGraphqlApiEnvironmentVariablesRequest putGraphqlApiEnvironmentVariablesRequest, AsyncHandler<PutGraphqlApiEnvironmentVariablesRequest,PutGraphqlApiEnvironmentVariablesResult> asyncHandler)
Creates a list of environmental variables in an API by its ID value.
When creating an environmental variable, it must follow the constraints below:
Both JavaScript and VTL templates support environmental variables.
Environmental variables are not evaluated before function invocation.
Environmental variables only support string values.
Any defined value in an environmental variable is considered a string literal and not expanded.
Variable evaluations should ideally be performed in the function code.
When creating an environmental variable key-value pair, it must follow the additional constraints below:
Keys must begin with a letter.
Keys must be at least two characters long.
Keys can only contain letters, numbers, and the underscore character (_).
Values can be up to 512 characters long.
You can configure up to 50 key-value pairs in a GraphQL API.
You can create a list of environmental variables by adding it to the environmentVariables payload as
a list in the format {"key1":"value1","key2":"value2", …}. Note that each call of the
PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing
environmental variable list of that API. This means the existing environmental variables will be lost. To avoid
this, you must include all existing and new environmental variables in the list each time you call this action.
putGraphqlApiEnvironmentVariablesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartDataSourceIntrospectionResult> startDataSourceIntrospectionAsync(StartDataSourceIntrospectionRequest startDataSourceIntrospectionRequest)
Creates a new introspection. Returns the introspectionId of the new introspection after its
creation.
startDataSourceIntrospectionRequest - Future<StartDataSourceIntrospectionResult> startDataSourceIntrospectionAsync(StartDataSourceIntrospectionRequest startDataSourceIntrospectionRequest, AsyncHandler<StartDataSourceIntrospectionRequest,StartDataSourceIntrospectionResult> asyncHandler)
Creates a new introspection. Returns the introspectionId of the new introspection after its
creation.
startDataSourceIntrospectionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartSchemaCreationResult> startSchemaCreationAsync(StartSchemaCreationRequest startSchemaCreationRequest)
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
startSchemaCreationRequest - Future<StartSchemaCreationResult> startSchemaCreationAsync(StartSchemaCreationRequest startSchemaCreationRequest, AsyncHandler<StartSchemaCreationRequest,StartSchemaCreationResult> asyncHandler)
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
startSchemaCreationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartSchemaMergeResult> startSchemaMergeAsync(StartSchemaMergeRequest startSchemaMergeRequest)
Initiates a merge operation. Returns a status that shows the result of the merge operation.
startSchemaMergeRequest - Future<StartSchemaMergeResult> startSchemaMergeAsync(StartSchemaMergeRequest startSchemaMergeRequest, AsyncHandler<StartSchemaMergeRequest,StartSchemaMergeResult> asyncHandler)
Initiates a merge operation. Returns a status that shows the result of the merge operation.
startSchemaMergeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Tags a resource with user-supplied tags.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Tags a resource with user-supplied tags.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Untags a resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Untags a resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateApiCacheResult> updateApiCacheAsync(UpdateApiCacheRequest updateApiCacheRequest)
Updates the cache for the GraphQL API.
updateApiCacheRequest - Represents the input of a UpdateApiCache operation.Future<UpdateApiCacheResult> updateApiCacheAsync(UpdateApiCacheRequest updateApiCacheRequest, AsyncHandler<UpdateApiCacheRequest,UpdateApiCacheResult> asyncHandler)
Updates the cache for the GraphQL API.
updateApiCacheRequest - Represents the input of a UpdateApiCache operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateApiKeyResult> updateApiKeyAsync(UpdateApiKeyRequest updateApiKeyRequest)
Updates an API key. You can update the key as long as it's not deleted.
updateApiKeyRequest - Future<UpdateApiKeyResult> updateApiKeyAsync(UpdateApiKeyRequest updateApiKeyRequest, AsyncHandler<UpdateApiKeyRequest,UpdateApiKeyResult> asyncHandler)
Updates an API key. You can update the key as long as it's not deleted.
updateApiKeyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest)
Updates a DataSource object.
updateDataSourceRequest - Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResult> asyncHandler)
Updates a DataSource object.
updateDataSourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDomainNameResult> updateDomainNameAsync(UpdateDomainNameRequest updateDomainNameRequest)
Updates a custom DomainName object.
updateDomainNameRequest - Future<UpdateDomainNameResult> updateDomainNameAsync(UpdateDomainNameRequest updateDomainNameRequest, AsyncHandler<UpdateDomainNameRequest,UpdateDomainNameResult> asyncHandler)
Updates a custom DomainName object.
updateDomainNameRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateFunctionResult> updateFunctionAsync(UpdateFunctionRequest updateFunctionRequest)
Updates a Function object.
updateFunctionRequest - Future<UpdateFunctionResult> updateFunctionAsync(UpdateFunctionRequest updateFunctionRequest, AsyncHandler<UpdateFunctionRequest,UpdateFunctionResult> asyncHandler)
Updates a Function object.
updateFunctionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateGraphqlApiResult> updateGraphqlApiAsync(UpdateGraphqlApiRequest updateGraphqlApiRequest)
Updates a GraphqlApi object.
updateGraphqlApiRequest - Future<UpdateGraphqlApiResult> updateGraphqlApiAsync(UpdateGraphqlApiRequest updateGraphqlApiRequest, AsyncHandler<UpdateGraphqlApiRequest,UpdateGraphqlApiResult> asyncHandler)
Updates a GraphqlApi object.
updateGraphqlApiRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateResolverResult> updateResolverAsync(UpdateResolverRequest updateResolverRequest)
Updates a Resolver object.
updateResolverRequest - Future<UpdateResolverResult> updateResolverAsync(UpdateResolverRequest updateResolverRequest, AsyncHandler<UpdateResolverRequest,UpdateResolverResult> asyncHandler)
Updates a Resolver object.
updateResolverRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateSourceApiAssociationResult> updateSourceApiAssociationAsync(UpdateSourceApiAssociationRequest updateSourceApiAssociationRequest)
Updates some of the configuration choices of a particular source API association.
updateSourceApiAssociationRequest - Future<UpdateSourceApiAssociationResult> updateSourceApiAssociationAsync(UpdateSourceApiAssociationRequest updateSourceApiAssociationRequest, AsyncHandler<UpdateSourceApiAssociationRequest,UpdateSourceApiAssociationResult> asyncHandler)
Updates some of the configuration choices of a particular source API association.
updateSourceApiAssociationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateTypeResult> updateTypeAsync(UpdateTypeRequest updateTypeRequest)
Updates a Type object.
updateTypeRequest - Future<UpdateTypeResult> updateTypeAsync(UpdateTypeRequest updateTypeRequest, AsyncHandler<UpdateTypeRequest,UpdateTypeResult> asyncHandler)
Updates a Type object.
updateTypeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.