@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSAppSyncClient extends AmazonWebServiceClient implements AWSAppSync
AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
protected static final ClientConfigurationFactory configFactory
public static AWSAppSyncClientBuilder builder()
public CreateApiKeyResult createApiKey(CreateApiKeyRequest request)
Creates a unique key that you can distribute to clients who are executing your API.
createApiKey
in interface AWSAppSync
createApiKeyRequest
- 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 from creation (for
CreateApiKey
) or from update (for UpdateApiKey
).public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
Creates a DataSource
object.
createDataSource
in interface AWSAppSync
createDataSourceRequest
- 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.public CreateGraphqlApiResult createGraphqlApi(CreateGraphqlApiRequest request)
Creates a GraphqlApi
object.
createGraphqlApi
in interface AWSAppSync
createGraphqlApiRequest
- 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.ApiLimitExceededException
- The GraphQL API exceeded a limit. Try your request again.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.
createResolver
in interface AWSAppSync
createResolverRequest
- 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.public CreateTypeResult createType(CreateTypeRequest request)
Creates a Type
object.
createType
in interface AWSAppSync
createTypeRequest
- 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.public DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest request)
Deletes an API key.
deleteApiKey
in interface AWSAppSync
deleteApiKeyRequest
- 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.public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
Deletes a DataSource
object.
deleteDataSource
in interface AWSAppSync
deleteDataSourceRequest
- 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.public DeleteGraphqlApiResult deleteGraphqlApi(DeleteGraphqlApiRequest request)
Deletes a GraphqlApi
object.
deleteGraphqlApi
in interface AWSAppSync
deleteGraphqlApiRequest
- 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.public DeleteResolverResult deleteResolver(DeleteResolverRequest request)
Deletes a Resolver
object.
deleteResolver
in interface AWSAppSync
deleteResolverRequest
- 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.public DeleteTypeResult deleteType(DeleteTypeRequest request)
Deletes a Type
object.
deleteType
in interface AWSAppSync
deleteTypeRequest
- 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.public GetDataSourceResult getDataSource(GetDataSourceRequest request)
Retrieves a DataSource
object.
getDataSource
in interface AWSAppSync
getDataSourceRequest
- 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.public GetGraphqlApiResult getGraphqlApi(GetGraphqlApiRequest request)
Retrieves a GraphqlApi
object.
getGraphqlApi
in interface AWSAppSync
getGraphqlApiRequest
- 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.public GetIntrospectionSchemaResult getIntrospectionSchema(GetIntrospectionSchemaRequest request)
Retrieves the introspection schema for a GraphQL API.
getIntrospectionSchema
in interface AWSAppSync
getIntrospectionSchemaRequest
- 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.public GetResolverResult getResolver(GetResolverRequest request)
Retrieves a Resolver
object.
getResolver
in interface AWSAppSync
getResolverRequest
- 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.public GetSchemaCreationStatusResult getSchemaCreationStatus(GetSchemaCreationStatusRequest request)
Retrieves the current status of a schema creation operation.
getSchemaCreationStatus
in interface AWSAppSync
getSchemaCreationStatusRequest
- 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.public GetTypeResult getType(GetTypeRequest request)
Retrieves a Type
object.
getType
in interface AWSAppSync
getTypeRequest
- 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.public ListApiKeysResult listApiKeys(ListApiKeysRequest request)
Lists the API keys for a given API.
API keys are deleted automatically sometime after they expire. However, they may still be included in the
response until they have actually been deleted. You can safely call DeleteApiKey
to manually delete
a key before it's automatically deleted.
listApiKeys
in interface AWSAppSync
listApiKeysRequest
- 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.public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
Lists the data sources for a given API.
listDataSources
in interface AWSAppSync
listDataSourcesRequest
- 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.public ListGraphqlApisResult listGraphqlApis(ListGraphqlApisRequest request)
Lists your GraphQL APIs.
listGraphqlApis
in interface AWSAppSync
listGraphqlApisRequest
- 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.public ListResolversResult listResolvers(ListResolversRequest request)
Lists the resolvers for a given API and type.
listResolvers
in interface AWSAppSync
listResolversRequest
- 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.public ListTypesResult listTypes(ListTypesRequest request)
Lists the types for a given API.
listTypes
in interface AWSAppSync
listTypesRequest
- 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.public StartSchemaCreationResult startSchemaCreation(StartSchemaCreationRequest request)
Adds a new schema to your GraphQL API.
This operation is asynchronous. Use to determine when it has completed.
startSchemaCreation
in interface AWSAppSync
startSchemaCreationRequest
- 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.public UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest request)
Updates an API key.
updateApiKey
in interface AWSAppSync
updateApiKeyRequest
- 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 from creation (for
CreateApiKey
) or from update (for UpdateApiKey
).public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
Updates a DataSource
object.
updateDataSource
in interface AWSAppSync
updateDataSourceRequest
- 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.public UpdateGraphqlApiResult updateGraphqlApi(UpdateGraphqlApiRequest request)
Updates a GraphqlApi
object.
updateGraphqlApi
in interface AWSAppSync
updateGraphqlApiRequest
- 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.public UpdateResolverResult updateResolver(UpdateResolverRequest request)
Updates a Resolver
object.
updateResolver
in interface AWSAppSync
updateResolverRequest
- 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.public UpdateTypeResult updateType(UpdateTypeRequest request)
Updates a Type
object.
updateType
in interface AWSAppSync
updateTypeRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AWSAppSync
request
- The originally executed requestCopyright © 2018. All rights reserved.