com.amazonaws.services.appsync

Interface AWSAppSync

All Known Subinterfaces:

AWSAppSyncAsync

All Known Implementing Classes:

AbstractAWSAppSync, AbstractAWSAppSyncAsync, AWSAppSyncAsyncClient, AWSAppSyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAppSync

Interface for accessing AWSAppSync.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSAppSync instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateApiResult	associateApi(AssociateApiRequest associateApiRequest) Maps an endpoint to your custom domain.
AssociateMergedGraphqlApiResult	associateMergedGraphqlApi(AssociateMergedGraphqlApiRequest associateMergedGraphqlApiRequest) Creates an association between a Merged API and source API using the source API's identifier.
AssociateSourceGraphqlApiResult	associateSourceGraphqlApi(AssociateSourceGraphqlApiRequest associateSourceGraphqlApiRequest) Creates an association between a Merged API and source API using the Merged API's identifier.
CreateApiCacheResult	createApiCache(CreateApiCacheRequest createApiCacheRequest) Creates a cache for the GraphQL API.
CreateApiKeyResult	createApiKey(CreateApiKeyRequest createApiKeyRequest) Creates a unique key that you can distribute to clients who invoke your API.
CreateDataSourceResult	createDataSource(CreateDataSourceRequest createDataSourceRequest) Creates a DataSource object.
CreateDomainNameResult	createDomainName(CreateDomainNameRequest createDomainNameRequest) Creates a custom DomainName object.
CreateFunctionResult	createFunction(CreateFunctionRequest createFunctionRequest) Creates a Function object.
CreateGraphqlApiResult	createGraphqlApi(CreateGraphqlApiRequest createGraphqlApiRequest) Creates a GraphqlApi object.
CreateResolverResult	createResolver(CreateResolverRequest createResolverRequest) Creates a Resolver object.
CreateTypeResult	createType(CreateTypeRequest createTypeRequest) Creates a Type object.
DeleteApiCacheResult	deleteApiCache(DeleteApiCacheRequest deleteApiCacheRequest) Deletes an ApiCache object.
DeleteApiKeyResult	deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest) Deletes an API key.
DeleteDataSourceResult	deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) Deletes a DataSource object.
DeleteDomainNameResult	deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest) Deletes a custom DomainName object.
DeleteFunctionResult	deleteFunction(DeleteFunctionRequest deleteFunctionRequest) Deletes a Function.
DeleteGraphqlApiResult	deleteGraphqlApi(DeleteGraphqlApiRequest deleteGraphqlApiRequest) Deletes a GraphqlApi object.
DeleteResolverResult	deleteResolver(DeleteResolverRequest deleteResolverRequest) Deletes a Resolver object.
DeleteTypeResult	deleteType(DeleteTypeRequest deleteTypeRequest) Deletes a Type object.
DisassociateApiResult	disassociateApi(DisassociateApiRequest disassociateApiRequest) Removes an ApiAssociation object from a custom domain.
DisassociateMergedGraphqlApiResult	disassociateMergedGraphqlApi(DisassociateMergedGraphqlApiRequest disassociateMergedGraphqlApiRequest) Deletes an association between a Merged API and source API using the source API's identifier and the association ID.
DisassociateSourceGraphqlApiResult	disassociateSourceGraphqlApi(DisassociateSourceGraphqlApiRequest disassociateSourceGraphqlApiRequest) Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.
EvaluateCodeResult	evaluateCode(EvaluateCodeRequest evaluateCodeRequest) Evaluates the given code and returns the response.
EvaluateMappingTemplateResult	evaluateMappingTemplate(EvaluateMappingTemplateRequest evaluateMappingTemplateRequest) Evaluates a given template and returns the response.
FlushApiCacheResult	flushApiCache(FlushApiCacheRequest flushApiCacheRequest) Flushes an ApiCache object.
GetApiAssociationResult	getApiAssociation(GetApiAssociationRequest getApiAssociationRequest) Retrieves an ApiAssociation object.
GetApiCacheResult	getApiCache(GetApiCacheRequest getApiCacheRequest) Retrieves an ApiCache object.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetDataSourceResult	getDataSource(GetDataSourceRequest getDataSourceRequest) Retrieves a DataSource object.
GetDataSourceIntrospectionResult	getDataSourceIntrospection(GetDataSourceIntrospectionRequest getDataSourceIntrospectionRequest) Retrieves the record of an existing introspection.
GetDomainNameResult	getDomainName(GetDomainNameRequest getDomainNameRequest) Retrieves a custom DomainName object.
GetFunctionResult	getFunction(GetFunctionRequest getFunctionRequest) Get a Function.
GetGraphqlApiResult	getGraphqlApi(GetGraphqlApiRequest getGraphqlApiRequest) Retrieves a GraphqlApi object.
GetGraphqlApiEnvironmentVariablesResult	getGraphqlApiEnvironmentVariables(GetGraphqlApiEnvironmentVariablesRequest getGraphqlApiEnvironmentVariablesRequest) Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
GetIntrospectionSchemaResult	getIntrospectionSchema(GetIntrospectionSchemaRequest getIntrospectionSchemaRequest) Retrieves the introspection schema for a GraphQL API.
GetResolverResult	getResolver(GetResolverRequest getResolverRequest) Retrieves a Resolver object.
GetSchemaCreationStatusResult	getSchemaCreationStatus(GetSchemaCreationStatusRequest getSchemaCreationStatusRequest) Retrieves the current status of a schema creation operation.
GetSourceApiAssociationResult	getSourceApiAssociation(GetSourceApiAssociationRequest getSourceApiAssociationRequest) Retrieves a SourceApiAssociation object.
GetTypeResult	getType(GetTypeRequest getTypeRequest) Retrieves a Type object.
ListApiKeysResult	listApiKeys(ListApiKeysRequest listApiKeysRequest) Lists the API keys for a given API.
ListDataSourcesResult	listDataSources(ListDataSourcesRequest listDataSourcesRequest) Lists the data sources for a given API.
ListDomainNamesResult	listDomainNames(ListDomainNamesRequest listDomainNamesRequest) Lists multiple custom domain names.
ListFunctionsResult	listFunctions(ListFunctionsRequest listFunctionsRequest) List multiple functions.
ListGraphqlApisResult	listGraphqlApis(ListGraphqlApisRequest listGraphqlApisRequest) Lists your GraphQL APIs.
ListResolversResult	listResolvers(ListResolversRequest listResolversRequest) Lists the resolvers for a given API and type.
ListResolversByFunctionResult	listResolversByFunction(ListResolversByFunctionRequest listResolversByFunctionRequest) List the resolvers that are associated with a specific function.
ListSourceApiAssociationsResult	listSourceApiAssociations(ListSourceApiAssociationsRequest listSourceApiAssociationsRequest) Lists the SourceApiAssociationSummary data.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for a resource.
ListTypesResult	listTypes(ListTypesRequest listTypesRequest) Lists the types for a given API.
ListTypesByAssociationResult	listTypesByAssociation(ListTypesByAssociationRequest listTypesByAssociationRequest) Lists Type objects by the source API association ID.
PutGraphqlApiEnvironmentVariablesResult	putGraphqlApiEnvironmentVariables(PutGraphqlApiEnvironmentVariablesRequest putGraphqlApiEnvironmentVariablesRequest) Creates a list of environmental variables in an API by its ID value.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDataSourceIntrospectionResult	startDataSourceIntrospection(StartDataSourceIntrospectionRequest startDataSourceIntrospectionRequest) Creates a new introspection.
StartSchemaCreationResult	startSchemaCreation(StartSchemaCreationRequest startSchemaCreationRequest) Adds a new schema to your GraphQL API.
StartSchemaMergeResult	startSchemaMerge(StartSchemaMergeRequest startSchemaMergeRequest) Initiates a merge operation.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Tags a resource with user-supplied tags.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Untags a resource.
UpdateApiCacheResult	updateApiCache(UpdateApiCacheRequest updateApiCacheRequest) Updates the cache for the GraphQL API.
UpdateApiKeyResult	updateApiKey(UpdateApiKeyRequest updateApiKeyRequest) Updates an API key.
UpdateDataSourceResult	updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) Updates a DataSource object.
UpdateDomainNameResult	updateDomainName(UpdateDomainNameRequest updateDomainNameRequest) Updates a custom DomainName object.
UpdateFunctionResult	updateFunction(UpdateFunctionRequest updateFunctionRequest) Updates a Function object.
UpdateGraphqlApiResult	updateGraphqlApi(UpdateGraphqlApiRequest updateGraphqlApiRequest) Updates a GraphqlApi object.
UpdateResolverResult	updateResolver(UpdateResolverRequest updateResolverRequest) Updates a Resolver object.
UpdateSourceApiAssociationResult	updateSourceApiAssociation(UpdateSourceApiAssociationRequest updateSourceApiAssociationRequest) Updates some of the configuration choices of a particular source API association.
UpdateTypeResult	updateType(UpdateTypeRequest updateTypeRequest) Updates a Type object.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateApi

AssociateApiResult associateApi(AssociateApiRequest associateApiRequest)

Maps an endpoint to your custom domain.

Parameters:

associateApiRequest -

Returns:

Result of the AssociateApi operation returned by the service.

Throws:

AccessDeniedException - You don't have access to perform this operation on this resource.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

See Also:

AWS API Documentation

associateMergedGraphqlApi

AssociateMergedGraphqlApiResult associateMergedGraphqlApi(AssociateMergedGraphqlApiRequest associateMergedGraphqlApiRequest)

Creates an association between a Merged API and source API using the source API's identifier.

Parameters:

associateMergedGraphqlApiRequest -

Returns:

Result of the AssociateMergedGraphqlApi operation returned by the service.

Throws:

UnauthorizedException - You aren't authorized to perform this operation.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

LimitExceededException - The request exceeded a limit. Try your request again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

See Also:

AWS API Documentation

associateSourceGraphqlApi

AssociateSourceGraphqlApiResult associateSourceGraphqlApi(AssociateSourceGraphqlApiRequest associateSourceGraphqlApiRequest)

Creates an association between a Merged API and source API using the Merged API's identifier.

Parameters:

associateSourceGraphqlApiRequest -

Returns:

Result of the AssociateSourceGraphqlApi operation returned by the service.

Throws:

UnauthorizedException - You aren't authorized to perform this operation.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

LimitExceededException - The request exceeded a limit. Try your request again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

See Also:

AWS API Documentation

createApiCache

CreateApiCacheResult createApiCache(CreateApiCacheRequest createApiCacheRequest)

Creates a cache for the GraphQL API.

Parameters:

createApiCacheRequest - Represents the input of a CreateApiCache operation.

Returns:

Result of the CreateApiCache operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

createApiKey

CreateApiKeyResult createApiKey(CreateApiKeyRequest createApiKeyRequest)

Creates a unique key that you can distribute to clients who invoke your API.

Parameters:

createApiKeyRequest -

Returns:

Result of the CreateApiKey operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

LimitExceededException - The request exceeded a limit. Try your request again.

UnauthorizedException - You aren't authorized to perform this operation.

LimitExceededException - The request exceeded a limit. Try your request again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

ApiKeyLimitExceededException - The API key exceeded a limit. Try your request again.

ApiKeyValidityOutOfBoundsException - The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey) or from update (for UpdateApiKey).

See Also:

AWS API Documentation

createDataSource

CreateDataSourceResult createDataSource(CreateDataSourceRequest createDataSourceRequest)

Creates a DataSource object.

Parameters:

createDataSourceRequest -

Returns:

Result of the CreateDataSource operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

createDomainName

CreateDomainNameResult createDomainName(CreateDomainNameRequest createDomainNameRequest)

Creates a custom DomainName object.

Parameters:

createDomainNameRequest -

Returns:

Result of the CreateDomainName operation returned by the service.

Throws:

AccessDeniedException - You don't have access to perform this operation on this resource.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

createFunction

CreateFunctionResult createFunction(CreateFunctionRequest createFunctionRequest)

Creates a Function object.

A function is a reusable entity. You can use multiple functions to compose the resolver logic.

Parameters:

createFunctionRequest -

Returns:

Result of the CreateFunction operation returned by the service.

Throws:

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

See Also:

AWS API Documentation

createGraphqlApi

CreateGraphqlApiResult createGraphqlApi(CreateGraphqlApiRequest createGraphqlApiRequest)

Creates a GraphqlApi object.

Parameters:

createGraphqlApiRequest -

Returns:

Result of the CreateGraphqlApi operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

LimitExceededException - The request exceeded a limit. Try your request again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

ApiLimitExceededException - The GraphQL API exceeded a limit. Try your request again.

See Also:

AWS API Documentation

createResolver

CreateResolverResult createResolver(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.

Parameters:

createResolverRequest -

Returns:

Result of the CreateResolver operation returned by the service.

Throws:

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

See Also:

AWS API Documentation

createType

CreateTypeResult createType(CreateTypeRequest createTypeRequest)

Creates a Type object.

Parameters:

createTypeRequest -

Returns:

Result of the CreateType operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

deleteApiCache

DeleteApiCacheResult deleteApiCache(DeleteApiCacheRequest deleteApiCacheRequest)

Deletes an ApiCache object.

Parameters:

deleteApiCacheRequest - Represents the input of a DeleteApiCache operation.

Returns:

Result of the DeleteApiCache operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

deleteApiKey

DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)

Deletes an API key.

Parameters:

deleteApiKeyRequest -

Returns:

Result of the DeleteApiKey operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

deleteDataSource

DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)

Deletes a DataSource object.

Parameters:

deleteDataSourceRequest -

Returns:

Result of the DeleteDataSource operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

deleteDomainName

DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)

Deletes a custom DomainName object.

Parameters:

deleteDomainNameRequest -

Returns:

Result of the DeleteDomainName operation returned by the service.

Throws:

AccessDeniedException - You don't have access to perform this operation on this resource.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

See Also:

AWS API Documentation

deleteFunction

DeleteFunctionResult deleteFunction(DeleteFunctionRequest deleteFunctionRequest)

Deletes a Function.

Parameters:

deleteFunctionRequest -

Returns:

Result of the DeleteFunction operation returned by the service.

Throws:

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

See Also:

AWS API Documentation

deleteGraphqlApi

DeleteGraphqlApiResult deleteGraphqlApi(DeleteGraphqlApiRequest deleteGraphqlApiRequest)

Deletes a GraphqlApi object.

Parameters:

deleteGraphqlApiRequest -

Returns:

Result of the DeleteGraphqlApi operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

AccessDeniedException - You don't have access to perform this operation on this resource.

See Also:

AWS API Documentation

deleteResolver

DeleteResolverResult deleteResolver(DeleteResolverRequest deleteResolverRequest)

Deletes a Resolver object.

Parameters:

deleteResolverRequest -

Returns:

Result of the DeleteResolver operation returned by the service.

Throws:

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

See Also:

AWS API Documentation

deleteType

DeleteTypeResult deleteType(DeleteTypeRequest deleteTypeRequest)

Deletes a Type object.

Parameters:

deleteTypeRequest -

Returns:

Result of the DeleteType operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

disassociateApi

DisassociateApiResult disassociateApi(DisassociateApiRequest disassociateApiRequest)

Removes an ApiAssociation object from a custom domain.

Parameters:

disassociateApiRequest -

Returns:

Result of the DisassociateApi operation returned by the service.

Throws:

AccessDeniedException - You don't have access to perform this operation on this resource.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

See Also:

AWS API Documentation

disassociateMergedGraphqlApi

DisassociateMergedGraphqlApiResult disassociateMergedGraphqlApi(DisassociateMergedGraphqlApiRequest disassociateMergedGraphqlApiRequest)

Deletes an association between a Merged API and source API using the source API's identifier and the association ID.

Parameters:

disassociateMergedGraphqlApiRequest -

Returns:

Result of the DisassociateMergedGraphqlApi operation returned by the service.

Throws:

UnauthorizedException - You aren't authorized to perform this operation.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

See Also:

AWS API Documentation

disassociateSourceGraphqlApi

DisassociateSourceGraphqlApiResult disassociateSourceGraphqlApi(DisassociateSourceGraphqlApiRequest disassociateSourceGraphqlApiRequest)

Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.

Parameters:

disassociateSourceGraphqlApiRequest -

Returns:

Result of the DisassociateSourceGraphqlApi operation returned by the service.

Throws:

UnauthorizedException - You aren't authorized to perform this operation.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

See Also:

AWS API Documentation

evaluateCode

EvaluateCodeResult evaluateCode(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.

Parameters:

evaluateCodeRequest -

Returns:

Result of the EvaluateCode operation returned by the service.

Throws:

AccessDeniedException - You don't have access to perform this operation on this resource.

InternalFailureException - An internal AppSync error occurred. Try your request again.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

See Also:

AWS API Documentation

evaluateMappingTemplate

EvaluateMappingTemplateResult evaluateMappingTemplate(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).

Parameters:

evaluateMappingTemplateRequest -

Returns:

Result of the EvaluateMappingTemplate operation returned by the service.

Throws:

AccessDeniedException - You don't have access to perform this operation on this resource.

InternalFailureException - An internal AppSync error occurred. Try your request again.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

See Also:

AWS API Documentation

flushApiCache

FlushApiCacheResult flushApiCache(FlushApiCacheRequest flushApiCacheRequest)

Flushes an ApiCache object.

Parameters:

flushApiCacheRequest - Represents the input of a FlushApiCache operation.

Returns:

Result of the FlushApiCache operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

getApiAssociation

GetApiAssociationResult getApiAssociation(GetApiAssociationRequest getApiAssociationRequest)

Retrieves an ApiAssociation object.

Parameters:

getApiAssociationRequest -

Returns:

Result of the GetApiAssociation operation returned by the service.

Throws:

AccessDeniedException - You don't have access to perform this operation on this resource.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

See Also:

AWS API Documentation

getApiCache

GetApiCacheResult getApiCache(GetApiCacheRequest getApiCacheRequest)

Retrieves an ApiCache object.

Parameters:

getApiCacheRequest - Represents the input of a GetApiCache operation.

Returns:

Result of the GetApiCache operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

getDataSource

GetDataSourceResult getDataSource(GetDataSourceRequest getDataSourceRequest)

Retrieves a DataSource object.

Parameters:

getDataSourceRequest -

Returns:

Result of the GetDataSource operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

getDataSourceIntrospection

GetDataSourceIntrospectionResult getDataSourceIntrospection(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.

Parameters:

getDataSourceIntrospectionRequest -

Returns:

Result of the GetDataSourceIntrospection operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

getDomainName

GetDomainNameResult getDomainName(GetDomainNameRequest getDomainNameRequest)

Retrieves a custom DomainName object.

Parameters:

getDomainNameRequest -

Returns:

Result of the GetDomainName operation returned by the service.

Throws:

AccessDeniedException - You don't have access to perform this operation on this resource.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

See Also:

AWS API Documentation

getFunction

GetFunctionResult getFunction(GetFunctionRequest getFunctionRequest)

Get a Function.

Parameters:

getFunctionRequest -

Returns:

Result of the GetFunction operation returned by the service.

Throws:

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

See Also:

AWS API Documentation

getGraphqlApi

GetGraphqlApiResult getGraphqlApi(GetGraphqlApiRequest getGraphqlApiRequest)

Retrieves a GraphqlApi object.

Parameters:

getGraphqlApiRequest -

Returns:

Result of the GetGraphqlApi operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

AccessDeniedException - You don't have access to perform this operation on this resource.

See Also:

AWS API Documentation

getGraphqlApiEnvironmentVariables

GetGraphqlApiEnvironmentVariablesResult getGraphqlApiEnvironmentVariables(GetGraphqlApiEnvironmentVariablesRequest getGraphqlApiEnvironmentVariablesRequest)

Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.

Parameters:

getGraphqlApiEnvironmentVariablesRequest -

Returns:

Result of the GetGraphqlApiEnvironmentVariables operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

AccessDeniedException - You don't have access to perform this operation on this resource.

See Also:

AWS API Documentation

getIntrospectionSchema

GetIntrospectionSchemaResult getIntrospectionSchema(GetIntrospectionSchemaRequest getIntrospectionSchemaRequest)

Retrieves the introspection schema for a GraphQL API.

Parameters:

getIntrospectionSchemaRequest -

Returns:

Result of the GetIntrospectionSchema operation returned by the service.

Throws:

GraphQLSchemaException - The GraphQL schema is not valid.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

getResolver

GetResolverResult getResolver(GetResolverRequest getResolverRequest)

Retrieves a Resolver object.

Parameters:

getResolverRequest -

Returns:

Result of the GetResolver operation returned by the service.

Throws:

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

See Also:

AWS API Documentation

getSchemaCreationStatus

GetSchemaCreationStatusResult getSchemaCreationStatus(GetSchemaCreationStatusRequest getSchemaCreationStatusRequest)

Retrieves the current status of a schema creation operation.

Parameters:

getSchemaCreationStatusRequest -

Returns:

Result of the GetSchemaCreationStatus operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

getSourceApiAssociation

GetSourceApiAssociationResult getSourceApiAssociation(GetSourceApiAssociationRequest getSourceApiAssociationRequest)

Retrieves a SourceApiAssociation object.

Parameters:

getSourceApiAssociationRequest -

Returns:

Result of the GetSourceApiAssociation operation returned by the service.

Throws:

UnauthorizedException - You aren't authorized to perform this operation.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

See Also:

AWS API Documentation

getType

GetTypeResult getType(GetTypeRequest getTypeRequest)

Retrieves a Type object.

Parameters:

getTypeRequest -

Returns:

Result of the GetType operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

listApiKeys

ListApiKeysResult listApiKeys(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.

Parameters:

listApiKeysRequest -

Returns:

Result of the ListApiKeys operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

listDataSources

ListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest)

Lists the data sources for a given API.

Parameters:

listDataSourcesRequest -

Returns:

Result of the ListDataSources operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

listDomainNames

ListDomainNamesResult listDomainNames(ListDomainNamesRequest listDomainNamesRequest)

Lists multiple custom domain names.

Parameters:

listDomainNamesRequest -

Returns:

Result of the ListDomainNames operation returned by the service.

Throws:

AccessDeniedException - You don't have access to perform this operation on this resource.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

listFunctions

ListFunctionsResult listFunctions(ListFunctionsRequest listFunctionsRequest)

List multiple functions.

Parameters:

listFunctionsRequest -

Returns:

Result of the ListFunctions operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

listGraphqlApis

ListGraphqlApisResult listGraphqlApis(ListGraphqlApisRequest listGraphqlApisRequest)

Lists your GraphQL APIs.

Parameters:

listGraphqlApisRequest -

Returns:

Result of the ListGraphqlApis operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

listResolvers

ListResolversResult listResolvers(ListResolversRequest listResolversRequest)

Lists the resolvers for a given API and type.

Parameters:

listResolversRequest -

Returns:

Result of the ListResolvers operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

listResolversByFunction

ListResolversByFunctionResult listResolversByFunction(ListResolversByFunctionRequest listResolversByFunctionRequest)

List the resolvers that are associated with a specific function.

Parameters:

listResolversByFunctionRequest -

Returns:

Result of the ListResolversByFunction operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

listSourceApiAssociations

ListSourceApiAssociationsResult listSourceApiAssociations(ListSourceApiAssociationsRequest listSourceApiAssociationsRequest)

Lists the SourceApiAssociationSummary data.

Parameters:

listSourceApiAssociationsRequest -

Returns:

Result of the ListSourceApiAssociations operation returned by the service.

Throws:

UnauthorizedException - You aren't authorized to perform this operation.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

LimitExceededException - The request exceeded a limit. Try your request again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

AccessDeniedException - You don't have access to perform this operation on this resource.

See Also:

AWS API Documentation

listTypes

ListTypesResult listTypes(ListTypesRequest listTypesRequest)

Lists the types for a given API.

Parameters:

listTypesRequest -

Returns:

Result of the ListTypes operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

listTypesByAssociation

ListTypesByAssociationResult listTypesByAssociation(ListTypesByAssociationRequest listTypesByAssociationRequest)

Lists Type objects by the source API association ID.

Parameters:

listTypesByAssociationRequest -

Returns:

Result of the ListTypesByAssociation operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

putGraphqlApiEnvironmentVariables

PutGraphqlApiEnvironmentVariablesResult putGraphqlApiEnvironmentVariables(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.

Parameters:

putGraphqlApiEnvironmentVariablesRequest -

Returns:

Result of the PutGraphqlApiEnvironmentVariables operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

AccessDeniedException - You don't have access to perform this operation on this resource.

See Also:

AWS API Documentation

startDataSourceIntrospection

StartDataSourceIntrospectionResult startDataSourceIntrospection(StartDataSourceIntrospectionRequest startDataSourceIntrospectionRequest)

Creates a new introspection. Returns the introspectionId of the new introspection after its creation.

Parameters:

startDataSourceIntrospectionRequest -

Returns:

Result of the StartDataSourceIntrospection operation returned by the service.

Throws:

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

See Also:

AWS API Documentation

startSchemaCreation

StartSchemaCreationResult startSchemaCreation(StartSchemaCreationRequest startSchemaCreationRequest)

Adds a new schema to your GraphQL API.

This operation is asynchronous. Use to determine when it has completed.

Parameters:

startSchemaCreationRequest -

Returns:

Result of the StartSchemaCreation operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

startSchemaMerge

StartSchemaMergeResult startSchemaMerge(StartSchemaMergeRequest startSchemaMergeRequest)

Initiates a merge operation. Returns a status that shows the result of the merge operation.

Parameters:

startSchemaMergeRequest -

Returns:

Result of the StartSchemaMerge operation returned by the service.

Throws:

UnauthorizedException - You aren't authorized to perform this operation.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Tags a resource with user-supplied tags.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

LimitExceededException - The request exceeded a limit. Try your request again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

AccessDeniedException - You don't have access to perform this operation on this resource.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Untags a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

LimitExceededException - The request exceeded a limit. Try your request again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

AccessDeniedException - You don't have access to perform this operation on this resource.

See Also:

AWS API Documentation

updateApiCache

UpdateApiCacheResult updateApiCache(UpdateApiCacheRequest updateApiCacheRequest)

Updates the cache for the GraphQL API.

Parameters:

updateApiCacheRequest - Represents the input of a UpdateApiCache operation.

Returns:

Result of the UpdateApiCache operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

updateApiKey

UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)

Updates an API key. You can update the key as long as it's not deleted.

Parameters:

updateApiKeyRequest -

Returns:

Result of the UpdateApiKey operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

LimitExceededException - The request exceeded a limit. Try your request again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

ApiKeyValidityOutOfBoundsException - The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey) or from update (for UpdateApiKey).

See Also:

AWS API Documentation

updateDataSource

UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)

Updates a DataSource object.

Parameters:

updateDataSourceRequest -

Returns:

Result of the UpdateDataSource operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

updateDomainName

UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)

Updates a custom DomainName object.

Parameters:

updateDomainNameRequest -

Returns:

Result of the UpdateDomainName operation returned by the service.

Throws:

AccessDeniedException - You don't have access to perform this operation on this resource.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

See Also:

AWS API Documentation

updateFunction

UpdateFunctionResult updateFunction(UpdateFunctionRequest updateFunctionRequest)

Updates a Function object.

Parameters:

updateFunctionRequest -

Returns:

Result of the UpdateFunction operation returned by the service.

Throws:

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

See Also:

AWS API Documentation

updateGraphqlApi

UpdateGraphqlApiResult updateGraphqlApi(UpdateGraphqlApiRequest updateGraphqlApiRequest)

Updates a GraphqlApi object.

Parameters:

updateGraphqlApiRequest -

Returns:

Result of the UpdateGraphqlApi operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

AccessDeniedException - You don't have access to perform this operation on this resource.

See Also:

AWS API Documentation

updateResolver

UpdateResolverResult updateResolver(UpdateResolverRequest updateResolverRequest)

Updates a Resolver object.

Parameters:

updateResolverRequest -

Returns:

Result of the UpdateResolver operation returned by the service.

Throws:

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

See Also:

AWS API Documentation

updateSourceApiAssociation

UpdateSourceApiAssociationResult updateSourceApiAssociation(UpdateSourceApiAssociationRequest updateSourceApiAssociationRequest)

Updates some of the configuration choices of a particular source API association.

Parameters:

updateSourceApiAssociationRequest -

Returns:

Result of the UpdateSourceApiAssociation operation returned by the service.

Throws:

UnauthorizedException - You aren't authorized to perform this operation.

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

InternalFailureException - An internal AppSync error occurred. Try your request again.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

See Also:

AWS API Documentation

updateType

UpdateTypeResult updateType(UpdateTypeRequest updateTypeRequest)

Updates a Type object.

Parameters:

updateTypeRequest -

Returns:

Result of the UpdateType operation returned by the service.

Throws:

BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

ConcurrentModificationException - Another modification is in progress at this time and it must complete before you can make your change.

NotFoundException - The resource specified in the request was not found. Check the resource, and then try again.

UnauthorizedException - You aren't authorized to perform this operation.

InternalFailureException - An internal AppSync error occurred. Try your request again.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.