@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSAppSync extends Object implements AWSAppSync
AWSAppSync
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
public AssociateApiResult associateApi(AssociateApiRequest request)
AWSAppSync
Maps an endpoint to your custom domain.
associateApi
in interface AWSAppSync
public AssociateMergedGraphqlApiResult associateMergedGraphqlApi(AssociateMergedGraphqlApiRequest request)
AWSAppSync
Creates an association between a Merged API and source API using the source API's identifier.
associateMergedGraphqlApi
in interface AWSAppSync
public AssociateSourceGraphqlApiResult associateSourceGraphqlApi(AssociateSourceGraphqlApiRequest request)
AWSAppSync
Creates an association between a Merged API and source API using the Merged API's identifier.
associateSourceGraphqlApi
in interface AWSAppSync
public CreateApiCacheResult createApiCache(CreateApiCacheRequest request)
AWSAppSync
Creates a cache for the GraphQL API.
createApiCache
in interface AWSAppSync
request
- Represents the input of a CreateApiCache
operation.public CreateApiKeyResult createApiKey(CreateApiKeyRequest request)
AWSAppSync
Creates a unique key that you can distribute to clients who invoke your API.
createApiKey
in interface AWSAppSync
public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
AWSAppSync
Creates a DataSource
object.
createDataSource
in interface AWSAppSync
public CreateDomainNameResult createDomainName(CreateDomainNameRequest request)
AWSAppSync
Creates a custom DomainName
object.
createDomainName
in interface AWSAppSync
public CreateFunctionResult createFunction(CreateFunctionRequest request)
AWSAppSync
Creates a Function
object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
createFunction
in interface AWSAppSync
public CreateGraphqlApiResult createGraphqlApi(CreateGraphqlApiRequest request)
AWSAppSync
Creates a GraphqlApi
object.
createGraphqlApi
in interface AWSAppSync
public CreateResolverResult createResolver(CreateResolverRequest request)
AWSAppSync
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.
createResolver
in interface AWSAppSync
public CreateTypeResult createType(CreateTypeRequest request)
AWSAppSync
Creates a Type
object.
createType
in interface AWSAppSync
public DeleteApiCacheResult deleteApiCache(DeleteApiCacheRequest request)
AWSAppSync
Deletes an ApiCache
object.
deleteApiCache
in interface AWSAppSync
request
- Represents the input of a DeleteApiCache
operation.public DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest request)
AWSAppSync
Deletes an API key.
deleteApiKey
in interface AWSAppSync
public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
AWSAppSync
Deletes a DataSource
object.
deleteDataSource
in interface AWSAppSync
public DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest request)
AWSAppSync
Deletes a custom DomainName
object.
deleteDomainName
in interface AWSAppSync
public DeleteFunctionResult deleteFunction(DeleteFunctionRequest request)
AWSAppSync
Deletes a Function
.
deleteFunction
in interface AWSAppSync
public DeleteGraphqlApiResult deleteGraphqlApi(DeleteGraphqlApiRequest request)
AWSAppSync
Deletes a GraphqlApi
object.
deleteGraphqlApi
in interface AWSAppSync
public DeleteResolverResult deleteResolver(DeleteResolverRequest request)
AWSAppSync
Deletes a Resolver
object.
deleteResolver
in interface AWSAppSync
public DeleteTypeResult deleteType(DeleteTypeRequest request)
AWSAppSync
Deletes a Type
object.
deleteType
in interface AWSAppSync
public DisassociateApiResult disassociateApi(DisassociateApiRequest request)
AWSAppSync
Removes an ApiAssociation
object from a custom domain.
disassociateApi
in interface AWSAppSync
public DisassociateMergedGraphqlApiResult disassociateMergedGraphqlApi(DisassociateMergedGraphqlApiRequest request)
AWSAppSync
Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
disassociateMergedGraphqlApi
in interface AWSAppSync
public DisassociateSourceGraphqlApiResult disassociateSourceGraphqlApi(DisassociateSourceGraphqlApiRequest request)
AWSAppSync
Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
disassociateSourceGraphqlApi
in interface AWSAppSync
public EvaluateCodeResult evaluateCode(EvaluateCodeRequest request)
AWSAppSync
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.
evaluateCode
in interface AWSAppSync
public EvaluateMappingTemplateResult evaluateMappingTemplate(EvaluateMappingTemplateRequest request)
AWSAppSync
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).
evaluateMappingTemplate
in interface AWSAppSync
public FlushApiCacheResult flushApiCache(FlushApiCacheRequest request)
AWSAppSync
Flushes an ApiCache
object.
flushApiCache
in interface AWSAppSync
request
- Represents the input of a FlushApiCache
operation.public GetApiAssociationResult getApiAssociation(GetApiAssociationRequest request)
AWSAppSync
Retrieves an ApiAssociation
object.
getApiAssociation
in interface AWSAppSync
public GetApiCacheResult getApiCache(GetApiCacheRequest request)
AWSAppSync
Retrieves an ApiCache
object.
getApiCache
in interface AWSAppSync
request
- Represents the input of a GetApiCache
operation.public GetDataSourceResult getDataSource(GetDataSourceRequest request)
AWSAppSync
Retrieves a DataSource
object.
getDataSource
in interface AWSAppSync
public GetDataSourceIntrospectionResult getDataSourceIntrospection(GetDataSourceIntrospectionRequest request)
AWSAppSync
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.
getDataSourceIntrospection
in interface AWSAppSync
public GetDomainNameResult getDomainName(GetDomainNameRequest request)
AWSAppSync
Retrieves a custom DomainName
object.
getDomainName
in interface AWSAppSync
public GetFunctionResult getFunction(GetFunctionRequest request)
AWSAppSync
Get a Function
.
getFunction
in interface AWSAppSync
public GetGraphqlApiResult getGraphqlApi(GetGraphqlApiRequest request)
AWSAppSync
Retrieves a GraphqlApi
object.
getGraphqlApi
in interface AWSAppSync
public GetGraphqlApiEnvironmentVariablesResult getGraphqlApiEnvironmentVariables(GetGraphqlApiEnvironmentVariablesRequest request)
AWSAppSync
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
getGraphqlApiEnvironmentVariables
in interface AWSAppSync
public GetIntrospectionSchemaResult getIntrospectionSchema(GetIntrospectionSchemaRequest request)
AWSAppSync
Retrieves the introspection schema for a GraphQL API.
getIntrospectionSchema
in interface AWSAppSync
public GetResolverResult getResolver(GetResolverRequest request)
AWSAppSync
Retrieves a Resolver
object.
getResolver
in interface AWSAppSync
public GetSchemaCreationStatusResult getSchemaCreationStatus(GetSchemaCreationStatusRequest request)
AWSAppSync
Retrieves the current status of a schema creation operation.
getSchemaCreationStatus
in interface AWSAppSync
public GetSourceApiAssociationResult getSourceApiAssociation(GetSourceApiAssociationRequest request)
AWSAppSync
Retrieves a SourceApiAssociation
object.
getSourceApiAssociation
in interface AWSAppSync
public GetTypeResult getType(GetTypeRequest request)
AWSAppSync
Retrieves a Type
object.
getType
in interface AWSAppSync
public ListApiKeysResult listApiKeys(ListApiKeysRequest request)
AWSAppSync
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.
listApiKeys
in interface AWSAppSync
public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
AWSAppSync
Lists the data sources for a given API.
listDataSources
in interface AWSAppSync
public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)
AWSAppSync
Lists multiple custom domain names.
listDomainNames
in interface AWSAppSync
public ListFunctionsResult listFunctions(ListFunctionsRequest request)
AWSAppSync
List multiple functions.
listFunctions
in interface AWSAppSync
public ListGraphqlApisResult listGraphqlApis(ListGraphqlApisRequest request)
AWSAppSync
Lists your GraphQL APIs.
listGraphqlApis
in interface AWSAppSync
public ListResolversResult listResolvers(ListResolversRequest request)
AWSAppSync
Lists the resolvers for a given API and type.
listResolvers
in interface AWSAppSync
public ListResolversByFunctionResult listResolversByFunction(ListResolversByFunctionRequest request)
AWSAppSync
List the resolvers that are associated with a specific function.
listResolversByFunction
in interface AWSAppSync
public ListSourceApiAssociationsResult listSourceApiAssociations(ListSourceApiAssociationsRequest request)
AWSAppSync
Lists the SourceApiAssociationSummary
data.
listSourceApiAssociations
in interface AWSAppSync
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSAppSync
Lists the tags for a resource.
listTagsForResource
in interface AWSAppSync
public ListTypesResult listTypes(ListTypesRequest request)
AWSAppSync
Lists the types for a given API.
listTypes
in interface AWSAppSync
public ListTypesByAssociationResult listTypesByAssociation(ListTypesByAssociationRequest request)
AWSAppSync
Lists Type
objects by the source API association ID.
listTypesByAssociation
in interface AWSAppSync
public PutGraphqlApiEnvironmentVariablesResult putGraphqlApiEnvironmentVariables(PutGraphqlApiEnvironmentVariablesRequest request)
AWSAppSync
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.
putGraphqlApiEnvironmentVariables
in interface AWSAppSync
public StartDataSourceIntrospectionResult startDataSourceIntrospection(StartDataSourceIntrospectionRequest request)
AWSAppSync
Creates a new introspection. Returns the introspectionId
of the new introspection after its
creation.
startDataSourceIntrospection
in interface AWSAppSync
public StartSchemaCreationResult startSchemaCreation(StartSchemaCreationRequest request)
AWSAppSync
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
startSchemaCreation
in interface AWSAppSync
public StartSchemaMergeResult startSchemaMerge(StartSchemaMergeRequest request)
AWSAppSync
Initiates a merge operation. Returns a status that shows the result of the merge operation.
startSchemaMerge
in interface AWSAppSync
public TagResourceResult tagResource(TagResourceRequest request)
AWSAppSync
Tags a resource with user-supplied tags.
tagResource
in interface AWSAppSync
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSAppSync
Untags a resource.
untagResource
in interface AWSAppSync
public UpdateApiCacheResult updateApiCache(UpdateApiCacheRequest request)
AWSAppSync
Updates the cache for the GraphQL API.
updateApiCache
in interface AWSAppSync
request
- Represents the input of a UpdateApiCache
operation.public UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest request)
AWSAppSync
Updates an API key. You can update the key as long as it's not deleted.
updateApiKey
in interface AWSAppSync
public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
AWSAppSync
Updates a DataSource
object.
updateDataSource
in interface AWSAppSync
public UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest request)
AWSAppSync
Updates a custom DomainName
object.
updateDomainName
in interface AWSAppSync
public UpdateFunctionResult updateFunction(UpdateFunctionRequest request)
AWSAppSync
Updates a Function
object.
updateFunction
in interface AWSAppSync
public UpdateGraphqlApiResult updateGraphqlApi(UpdateGraphqlApiRequest request)
AWSAppSync
Updates a GraphqlApi
object.
updateGraphqlApi
in interface AWSAppSync
public UpdateResolverResult updateResolver(UpdateResolverRequest request)
AWSAppSync
Updates a Resolver
object.
updateResolver
in interface AWSAppSync
public UpdateSourceApiAssociationResult updateSourceApiAssociation(UpdateSourceApiAssociationRequest request)
AWSAppSync
Updates some of the configuration choices of a particular source API association.
updateSourceApiAssociation
in interface AWSAppSync
public UpdateTypeResult updateType(UpdateTypeRequest request)
AWSAppSync
Updates a Type
object.
updateType
in interface AWSAppSync
public void shutdown()
AWSAppSync
shutdown
in interface AWSAppSync
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSAppSync
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSAppSync
request
- The originally executed request.