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.

AWS 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
CreateApiKeyResult	createApiKey(CreateApiKeyRequest createApiKeyRequest) Creates a unique key that you can distribute to clients who are executing your API.
CreateDataSourceResult	createDataSource(CreateDataSourceRequest createDataSourceRequest) Creates a DataSource 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.
DeleteApiKeyResult	deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest) Deletes an API key.
DeleteDataSourceResult	deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) Deletes a DataSource object.
DeleteGraphqlApiResult	deleteGraphqlApi(DeleteGraphqlApiRequest deleteGraphqlApiRequest) Deletes a GraphqlApi object.
DeleteResolverResult	deleteResolver(DeleteResolverRequest deleteResolverRequest) Deletes a Resolver object.
DeleteTypeResult	deleteType(DeleteTypeRequest deleteTypeRequest) Deletes a Type 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.
GetGraphqlApiResult	getGraphqlApi(GetGraphqlApiRequest getGraphqlApiRequest) Retrieves a GraphqlApi object.
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.
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.
ListGraphqlApisResult	listGraphqlApis(ListGraphqlApisRequest listGraphqlApisRequest) Lists your GraphQL APIs.
ListResolversResult	listResolvers(ListResolversRequest listResolversRequest) Lists the resolvers for a given API and type.
ListTypesResult	listTypes(ListTypesRequest listTypesRequest) 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 startSchemaCreationRequest) Adds a new schema to your GraphQL API.
UpdateApiKeyResult	updateApiKey(UpdateApiKeyRequest updateApiKeyRequest) Updates an API key.
UpdateDataSourceResult	updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) Updates a DataSource object.
UpdateGraphqlApiResult	updateGraphqlApi(UpdateGraphqlApiRequest updateGraphqlApiRequest) Updates a GraphqlApi object.
UpdateResolverResult	updateResolver(UpdateResolverRequest updateResolverRequest) Updates a Resolver object.
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

createApiKey

CreateApiKeyResult createApiKey(CreateApiKeyRequest createApiKeyRequest)

Creates a unique key that you can distribute to clients who are executing 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 try again.

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

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

UnauthorizedException - You are not authorized to perform this operation.

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

InternalFailureException - An internal AWS 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.

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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS AppSync error occurred. Try your request 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 try again.

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

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

UnauthorizedException - You are not authorized to perform this operation.

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

LimitExceededException - The request exceeded a limit. 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 being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS AppSync error occurred. Try your request 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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS 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 try again.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS 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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS AppSync error occurred. Try your request 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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

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

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 being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS AppSync error occurred. Try your request 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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS 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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

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

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 try again.

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

UnauthorizedException - You are not authorized to perform this operation.

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

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 try again.

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS 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 being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not 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 try again.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS AppSync error occurred. Try your request 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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS 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.

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 try again.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS 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 try again.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS 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 try again.

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS 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 try again.

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

UnauthorizedException - You are not authorized to perform this operation.

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

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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS AppSync error occurred. Try your request 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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

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

See Also:

AWS API Documentation

updateApiKey

UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)

Updates an API key.

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 try again.

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

UnauthorizedException - You are not authorized to perform this operation.

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

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

ApiKeyValidityOutOfBoundsException - The API key expiration must be set to a value between 1 and 365 days.

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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS AppSync error occurred. Try your request 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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

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

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 being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

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

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 try again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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

UnauthorizedException - You are not authorized to perform this operation.

InternalFailureException - An internal AWS 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.