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.

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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSAppSyncClientBuilder	builder()
CreateApiKeyResult	createApiKey(CreateApiKeyRequest request) Creates a unique key that you can distribute to clients who are executing your API.
CreateDataSourceResult	createDataSource(CreateDataSourceRequest request) Creates a DataSource 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.
DeleteApiKeyResult	deleteApiKey(DeleteApiKeyRequest request) Deletes an API key.
DeleteDataSourceResult	deleteDataSource(DeleteDataSourceRequest request) Deletes a DataSource object.
DeleteGraphqlApiResult	deleteGraphqlApi(DeleteGraphqlApiRequest request) Deletes a GraphqlApi object.
DeleteResolverResult	deleteResolver(DeleteResolverRequest request) Deletes a Resolver object.
DeleteTypeResult	deleteType(DeleteTypeRequest request) 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 request) Retrieves a DataSource object.
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.
ListGraphqlApisResult	listGraphqlApis(ListGraphqlApisRequest request) Lists your GraphQL APIs.
ListResolversResult	listResolvers(ListResolversRequest request) Lists the resolvers for a given API and type.
ListTypesResult	listTypes(ListTypesRequest request) Lists the types for a given API.
StartSchemaCreationResult	startSchemaCreation(StartSchemaCreationRequest request) Adds a new schema to your GraphQL API.
UpdateDataSourceResult	updateDataSource(UpdateDataSourceRequest request) Updates a DataSource 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, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

shutdown

Method Detail

builder

public static AWSAppSyncClientBuilder builder()

createApiKey

public CreateApiKeyResult createApiKey(CreateApiKeyRequest request)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public ListApiKeysResult listApiKeys(ListApiKeysRequest request)

Lists the API keys for a given API.

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

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

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

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

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

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

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

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

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

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

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.