com.amazonaws.services.appsync

Class AWSAppSyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.appsync.AWSAppSyncClient

All Implemented Interfaces:

AWSAppSync

Direct Known Subclasses:

AWSAppSyncAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSAppSyncClient
extends AmazonWebServiceClient
implements AWSAppSync

Client for accessing AWSAppSync. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.appsync.AWSAppSync

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateApiResult	associateApi(AssociateApiRequest request) Maps an endpoint to your custom domain.
static AWSAppSyncClientBuilder	builder()
CreateApiCacheResult	createApiCache(CreateApiCacheRequest request) Creates a cache for the GraphQL API.
CreateApiKeyResult	createApiKey(CreateApiKeyRequest request) Creates a unique key that you can distribute to clients who invoke your API.
CreateDataSourceResult	createDataSource(CreateDataSourceRequest request) Creates a DataSource object.
CreateDomainNameResult	createDomainName(CreateDomainNameRequest request) Creates a custom DomainName object.
CreateFunctionResult	createFunction(CreateFunctionRequest request) Creates a Function object.
CreateGraphqlApiResult	createGraphqlApi(CreateGraphqlApiRequest request) Creates a GraphqlApi object.
CreateResolverResult	createResolver(CreateResolverRequest request) Creates a Resolver object.
CreateTypeResult	createType(CreateTypeRequest request) Creates a Type object.
DeleteApiCacheResult	deleteApiCache(DeleteApiCacheRequest request) Deletes an ApiCache object.
DeleteApiKeyResult	deleteApiKey(DeleteApiKeyRequest request) Deletes an API key.
DeleteDataSourceResult	deleteDataSource(DeleteDataSourceRequest request) Deletes a DataSource object.
DeleteDomainNameResult	deleteDomainName(DeleteDomainNameRequest request) Deletes a custom DomainName object.
DeleteFunctionResult	deleteFunction(DeleteFunctionRequest request) Deletes a Function.
DeleteGraphqlApiResult	deleteGraphqlApi(DeleteGraphqlApiRequest request) Deletes a GraphqlApi object.
DeleteResolverResult	deleteResolver(DeleteResolverRequest request) Deletes a Resolver object.
DeleteTypeResult	deleteType(DeleteTypeRequest request) Deletes a Type object.
DisassociateApiResult	disassociateApi(DisassociateApiRequest request) Removes an ApiAssociation object from a custom domain.
EvaluateCodeResult	evaluateCode(EvaluateCodeRequest request) Evaluates the given code and returns the response.
EvaluateMappingTemplateResult	evaluateMappingTemplate(EvaluateMappingTemplateRequest request) Evaluates a given template and returns the response.
FlushApiCacheResult	flushApiCache(FlushApiCacheRequest request) Flushes an ApiCache object.
GetApiAssociationResult	getApiAssociation(GetApiAssociationRequest request) Retrieves an ApiAssociation object.
GetApiCacheResult	getApiCache(GetApiCacheRequest request) 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 request) Retrieves a DataSource object.
GetDomainNameResult	getDomainName(GetDomainNameRequest request) Retrieves a custom DomainName object.
GetFunctionResult	getFunction(GetFunctionRequest request) Get a Function.
GetGraphqlApiResult	getGraphqlApi(GetGraphqlApiRequest request) Retrieves a GraphqlApi object.
GetIntrospectionSchemaResult	getIntrospectionSchema(GetIntrospectionSchemaRequest request) Retrieves the introspection schema for a GraphQL API.
GetResolverResult	getResolver(GetResolverRequest request) Retrieves a Resolver object.
GetSchemaCreationStatusResult	getSchemaCreationStatus(GetSchemaCreationStatusRequest request) Retrieves the current status of a schema creation operation.
GetTypeResult	getType(GetTypeRequest request) Retrieves a Type object.
ListApiKeysResult	listApiKeys(ListApiKeysRequest request) Lists the API keys for a given API.
ListDataSourcesResult	listDataSources(ListDataSourcesRequest request) Lists the data sources for a given API.
ListDomainNamesResult	listDomainNames(ListDomainNamesRequest request) Lists multiple custom domain names.
ListFunctionsResult	listFunctions(ListFunctionsRequest request) List multiple functions.
ListGraphqlApisResult	listGraphqlApis(ListGraphqlApisRequest request) Lists your GraphQL APIs.
ListResolversResult	listResolvers(ListResolversRequest request) Lists the resolvers for a given API and type.
ListResolversByFunctionResult	listResolversByFunction(ListResolversByFunctionRequest request) List the resolvers that are associated with a specific function.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags for a resource.
ListTypesResult	listTypes(ListTypesRequest request) Lists the types for a given API.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartSchemaCreationResult	startSchemaCreation(StartSchemaCreationRequest request) Adds a new schema to your GraphQL API.
TagResourceResult	tagResource(TagResourceRequest request) Tags a resource with user-supplied tags.
UntagResourceResult	untagResource(UntagResourceRequest request) Untags a resource.
UpdateApiCacheResult	updateApiCache(UpdateApiCacheRequest request) Updates the cache for the GraphQL API.
UpdateApiKeyResult	updateApiKey(UpdateApiKeyRequest request) Updates an API key.
UpdateDataSourceResult	updateDataSource(UpdateDataSourceRequest request) Updates a DataSource object.
UpdateDomainNameResult	updateDomainName(UpdateDomainNameRequest request) Updates a custom DomainName object.
UpdateFunctionResult	updateFunction(UpdateFunctionRequest request) Updates a Function object.
UpdateGraphqlApiResult	updateGraphqlApi(UpdateGraphqlApiRequest request) Updates a GraphqlApi object.
UpdateResolverResult	updateResolver(UpdateResolverRequest request) Updates a Resolver object.
UpdateTypeResult	updateType(UpdateTypeRequest request) Updates a Type object.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSAppSyncClientBuilder builder()

associateApi

public AssociateApiResult associateApi(AssociateApiRequest request)

Maps an endpoint to your custom domain.

Specified by:

associateApi in interface AWSAppSync

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

createApiCache

public CreateApiCacheResult createApiCache(CreateApiCacheRequest request)

Creates a cache for the GraphQL API.

Specified by:

createApiCache in interface AWSAppSync

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

public CreateApiKeyResult createApiKey(CreateApiKeyRequest request)

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

Specified by:

createApiKey in interface AWSAppSync

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

public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)

Creates a DataSource object.

Specified by:

createDataSource in interface AWSAppSync

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

public CreateDomainNameResult createDomainName(CreateDomainNameRequest request)

Creates a custom DomainName object.

Specified by:

createDomainName in interface AWSAppSync

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

public CreateFunctionResult createFunction(CreateFunctionRequest request)

Creates a Function object.

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

Specified by:

createFunction in interface AWSAppSync

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.

See Also:

AWS API Documentation

createGraphqlApi

public CreateGraphqlApiResult createGraphqlApi(CreateGraphqlApiRequest request)

Creates a GraphqlApi object.

Specified by:

createGraphqlApi in interface AWSAppSync

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

public CreateResolverResult createResolver(CreateResolverRequest request)

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.

Specified by:

createResolver in interface AWSAppSync

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

public CreateTypeResult createType(CreateTypeRequest request)

Creates a Type object.

Specified by:

createType in interface AWSAppSync

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

public DeleteApiCacheResult deleteApiCache(DeleteApiCacheRequest request)

Deletes an ApiCache object.

Specified by:

deleteApiCache in interface AWSAppSync

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

public DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest request)

Deletes an API key.

Specified by:

deleteApiKey in interface AWSAppSync

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

public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)

Deletes a DataSource object.

Specified by:

deleteDataSource in interface AWSAppSync

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

public DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest request)

Deletes a custom DomainName object.

Specified by:

deleteDomainName in interface AWSAppSync

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

public DeleteFunctionResult deleteFunction(DeleteFunctionRequest request)

Deletes a Function.

Specified by:

deleteFunction in interface AWSAppSync

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.

See Also:

AWS API Documentation

deleteGraphqlApi

public DeleteGraphqlApiResult deleteGraphqlApi(DeleteGraphqlApiRequest request)

Deletes a GraphqlApi object.

Specified by:

deleteGraphqlApi in interface AWSAppSync

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

public DeleteResolverResult deleteResolver(DeleteResolverRequest request)

Deletes a Resolver object.

Specified by:

deleteResolver in interface AWSAppSync

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

public DeleteTypeResult deleteType(DeleteTypeRequest request)

Deletes a Type object.

Specified by:

deleteType in interface AWSAppSync

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

public DisassociateApiResult disassociateApi(DisassociateApiRequest request)

Removes an ApiAssociation object from a custom domain.

Specified by:

disassociateApi in interface AWSAppSync

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

evaluateCode

public EvaluateCodeResult evaluateCode(EvaluateCodeRequest request)

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.

Specified by:

evaluateCode in interface AWSAppSync

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

public EvaluateMappingTemplateResult evaluateMappingTemplate(EvaluateMappingTemplateRequest request)

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).

Specified by:

evaluateMappingTemplate in interface AWSAppSync

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

public FlushApiCacheResult flushApiCache(FlushApiCacheRequest request)

Flushes an ApiCache object.

Specified by:

flushApiCache in interface AWSAppSync

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

public GetApiAssociationResult getApiAssociation(GetApiAssociationRequest request)

Retrieves an ApiAssociation object.

Specified by:

getApiAssociation in interface AWSAppSync

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

public GetApiCacheResult getApiCache(GetApiCacheRequest request)

Retrieves an ApiCache object.

Specified by:

getApiCache in interface AWSAppSync

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

public GetDataSourceResult getDataSource(GetDataSourceRequest request)

Retrieves a DataSource object.

Specified by:

getDataSource in interface AWSAppSync

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

getDomainName

public GetDomainNameResult getDomainName(GetDomainNameRequest request)

Retrieves a custom DomainName object.

Specified by:

getDomainName in interface AWSAppSync

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

public GetFunctionResult getFunction(GetFunctionRequest request)

Get a Function.

Specified by:

getFunction in interface AWSAppSync

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

public GetGraphqlApiResult getGraphqlApi(GetGraphqlApiRequest request)

Retrieves a GraphqlApi object.

Specified by:

getGraphqlApi in interface AWSAppSync

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

getIntrospectionSchema

public GetIntrospectionSchemaResult getIntrospectionSchema(GetIntrospectionSchemaRequest request)

Retrieves the introspection schema for a GraphQL API.

Specified by:

getIntrospectionSchema in interface AWSAppSync

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

public GetResolverResult getResolver(GetResolverRequest request)

Retrieves a Resolver object.

Specified by:

getResolver in interface AWSAppSync

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

public GetSchemaCreationStatusResult getSchemaCreationStatus(GetSchemaCreationStatusRequest request)

Retrieves the current status of a schema creation operation.

Specified by:

getSchemaCreationStatus in interface AWSAppSync

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

getType

public GetTypeResult getType(GetTypeRequest request)

Retrieves a Type object.

Specified by:

getType in interface AWSAppSync

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

public ListApiKeysResult listApiKeys(ListApiKeysRequest request)

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.

Specified by:

listApiKeys in interface AWSAppSync

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

public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)

Lists the data sources for a given API.

Specified by:

listDataSources in interface AWSAppSync

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

public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)

Lists multiple custom domain names.

Specified by:

listDomainNames in interface AWSAppSync

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

public ListFunctionsResult listFunctions(ListFunctionsRequest request)

List multiple functions.

Specified by:

listFunctions in interface AWSAppSync

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

public ListGraphqlApisResult listGraphqlApis(ListGraphqlApisRequest request)

Lists your GraphQL APIs.

Specified by:

listGraphqlApis in interface AWSAppSync

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

public ListResolversResult listResolvers(ListResolversRequest request)

Lists the resolvers for a given API and type.

Specified by:

listResolvers in interface AWSAppSync

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

public ListResolversByFunctionResult listResolversByFunction(ListResolversByFunctionRequest request)

List the resolvers that are associated with a specific function.

Specified by:

listResolversByFunction in interface AWSAppSync

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

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags for a resource.

Specified by:

listTagsForResource in interface AWSAppSync

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

public ListTypesResult listTypes(ListTypesRequest request)

Lists the types for a given API.

Specified by:

listTypes in interface AWSAppSync

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

startSchemaCreation

public StartSchemaCreationResult startSchemaCreation(StartSchemaCreationRequest request)

Adds a new schema to your GraphQL API.

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

Specified by:

startSchemaCreation in interface AWSAppSync

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

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Tags a resource with user-supplied tags.

Specified by:

tagResource in interface AWSAppSync

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Untags a resource.

Specified by:

untagResource in interface AWSAppSync

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

public UpdateApiCacheResult updateApiCache(UpdateApiCacheRequest request)

Updates the cache for the GraphQL API.

Specified by:

updateApiCache in interface AWSAppSync

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

public UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest request)

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

Specified by:

updateApiKey in interface AWSAppSync

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

public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)

Updates a DataSource object.

Specified by:

updateDataSource in interface AWSAppSync

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

public UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest request)

Updates a custom DomainName object.

Specified by:

updateDomainName in interface AWSAppSync

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

public UpdateFunctionResult updateFunction(UpdateFunctionRequest request)

Updates a Function object.

Specified by:

updateFunction in interface AWSAppSync

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.

See Also:

AWS API Documentation

updateGraphqlApi

public UpdateGraphqlApiResult updateGraphqlApi(UpdateGraphqlApiRequest request)

Updates a GraphqlApi object.

Specified by:

updateGraphqlApi in interface AWSAppSync

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

public UpdateResolverResult updateResolver(UpdateResolverRequest request)

Updates a Resolver object.

Specified by:

updateResolver in interface AWSAppSync

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

updateType

public UpdateTypeResult updateType(UpdateTypeRequest request)

Updates a Type object.

Specified by:

updateType in interface AWSAppSync

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSAppSync

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from interface: AWSAppSync

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.

Specified by:

shutdown in interface AWSAppSync

Overrides:

shutdown in class AmazonWebServiceClient