AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AccessDeniedException |
You don't have access to perform this operation on this resource. |
|
AdditionalAuthenticationProvider |
Describes an additional authentication provider. |
|
ApiAssociation |
Describes an |
|
ApiCache |
The |
|
ApiKey |
Describes an API key. Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions: da1: We introduced this version at launch in November 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid after February 21, 2018, and they should no longer be used.
da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.
|
|
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 |
|
ApiLimitExceededException |
The GraphQL API exceeded a limit. Try your request again. |
|
AppSyncRuntime |
Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified. |
|
AssociateApiRequest |
Container for the parameters to the AssociateApi operation. Maps an endpoint to your custom domain. |
|
AssociateApiResponse |
This is the response object from the AssociateApi operation. |
|
AssociateMergedGraphqlApiRequest |
Container for the parameters to the AssociateMergedGraphqlApi operation. Creates an association between a Merged API and source API using the source API's identifier. |
|
AssociateMergedGraphqlApiResponse |
This is the response object from the AssociateMergedGraphqlApi operation. |
|
AssociateSourceGraphqlApiRequest |
Container for the parameters to the AssociateSourceGraphqlApi operation. Creates an association between a Merged API and source API using the Merged API's identifier. |
|
AssociateSourceGraphqlApiResponse |
This is the response object from the AssociateSourceGraphqlApi operation. |
|
AuthorizationConfig |
The authorization configuration in case the HTTP endpoint requires authorization. |
|
AwsIamConfig |
The Identity and Access Management (IAM) configuration. |
|
BadRequestDetail |
Provides further details for the reason behind the bad request. For reason type |
|
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. |
|
CachingConfig |
The caching configuration for a resolver that has caching activated. |
|
CodeError |
Describes an AppSync error. |
|
CodeErrorLocation |
Describes the location of the error in a code sample. |
|
CognitoUserPoolConfig |
Describes an Amazon Cognito user pool configuration. |
|
ConcurrentModificationException |
Another modification is in progress at this time and it must complete before you can make your change. |
|
CreateApiCacheRequest |
Container for the parameters to the CreateApiCache operation. Creates a cache for the GraphQL API. |
|
CreateApiCacheResponse |
Represents the output of a |
|
CreateApiKeyRequest |
Container for the parameters to the CreateApiKey operation. Creates a unique key that you can distribute to clients who invoke your API. |
|
CreateApiKeyResponse |
This is the response object from the CreateApiKey operation. |
|
CreateDataSourceRequest |
Container for the parameters to the CreateDataSource operation.
Creates a |
|
CreateDataSourceResponse |
This is the response object from the CreateDataSource operation. |
|
CreateDomainNameRequest |
Container for the parameters to the CreateDomainName operation.
Creates a custom |
|
CreateDomainNameResponse |
This is the response object from the CreateDomainName operation. |
|
CreateFunctionRequest |
Container for the parameters to the CreateFunction operation.
Creates a A function is a reusable entity. You can use multiple functions to compose the resolver logic. |
|
CreateFunctionResponse |
This is the response object from the CreateFunction operation. |
|
CreateGraphqlApiRequest |
Container for the parameters to the CreateGraphqlApi operation.
Creates a |
|
CreateGraphqlApiResponse |
This is the response object from the CreateGraphqlApi operation. |
|
CreateResolverRequest |
Container for the parameters to the CreateResolver operation.
Creates a A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL. |
|
CreateResolverResponse |
This is the response object from the CreateResolver operation. |
|
CreateTypeRequest |
Container for the parameters to the CreateType operation.
Creates a |
|
CreateTypeResponse |
This is the response object from the CreateType operation. |
|
DataSource |
Describes a data source. |
|
DataSourceIntrospectionModel |
Contains the introspected data that was retrieved from the data source. |
|
DataSourceIntrospectionModelField |
Represents the fields that were retrieved from the introspected data. |
|
DataSourceIntrospectionModelFieldType |
Represents the type data for each field retrieved from the introspection. |
|
DataSourceIntrospectionModelIndex |
The index that was retrieved from the introspected data. |
|
DataSourceIntrospectionResult |
Represents the output of a |
|
DeleteApiCacheRequest |
Container for the parameters to the DeleteApiCache operation.
Deletes an |
|
DeleteApiCacheResponse |
Represents the output of a |
|
DeleteApiKeyRequest |
Container for the parameters to the DeleteApiKey operation. Deletes an API key. |
|
DeleteApiKeyResponse |
This is the response object from the DeleteApiKey operation. |
|
DeleteDataSourceRequest |
Container for the parameters to the DeleteDataSource operation.
Deletes a |
|
DeleteDataSourceResponse |
This is the response object from the DeleteDataSource operation. |
|
DeleteDomainNameRequest |
Container for the parameters to the DeleteDomainName operation.
Deletes a custom |
|
DeleteDomainNameResponse |
This is the response object from the DeleteDomainName operation. |
|
DeleteFunctionRequest |
Container for the parameters to the DeleteFunction operation.
Deletes a |
|
DeleteFunctionResponse |
This is the response object from the DeleteFunction operation. |
|
DeleteGraphqlApiRequest |
Container for the parameters to the DeleteGraphqlApi operation.
Deletes a |
|
DeleteGraphqlApiResponse |
This is the response object from the DeleteGraphqlApi operation. |
|
DeleteResolverRequest |
Container for the parameters to the DeleteResolver operation.
Deletes a |
|
DeleteResolverResponse |
This is the response object from the DeleteResolver operation. |
|
DeleteTypeRequest |
Container for the parameters to the DeleteType operation.
Deletes a |
|
DeleteTypeResponse |
This is the response object from the DeleteType operation. |
|
DeltaSyncConfig |
Describes a Delta Sync configuration. |
|
DisassociateApiRequest |
Container for the parameters to the DisassociateApi operation.
Removes an |
|
DisassociateApiResponse |
This is the response object from the DisassociateApi operation. |
|
DisassociateMergedGraphqlApiRequest |
Container for the parameters to the DisassociateMergedGraphqlApi operation. Deletes an association between a Merged API and source API using the source API's identifier and the association ID. |
|
DisassociateMergedGraphqlApiResponse |
This is the response object from the DisassociateMergedGraphqlApi operation. |
|
DisassociateSourceGraphqlApiRequest |
Container for the parameters to the DisassociateSourceGraphqlApi operation. Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID. |
|
DisassociateSourceGraphqlApiResponse |
This is the response object from the DisassociateSourceGraphqlApi operation. |
|
DomainNameConfig |
Describes a configuration for a custom domain. |
|
DynamodbDataSourceConfig |
Describes an Amazon DynamoDB data source configuration. |
|
ElasticsearchDataSourceConfig |
Describes an OpenSearch data source configuration. As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source. |
|
EnhancedMetricsConfig |
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
Enhanced metrics can be configured at the resolver, data source, and operation levels.
|
|
ErrorDetail |
Contains the list of errors generated. When using JavaScript, this will apply to the request or response function evaluation. |
|
EvaluateCodeErrorDetail |
Contains the list of errors from a code evaluation response. |
|
EvaluateCodeRequest |
Container for the parameters to the EvaluateCode operation.
Evaluates the given code and returns the response. The code definition requirements
depend on the specified runtime. For |
|
EvaluateCodeResponse |
This is the response object from the EvaluateCode operation. |
|
EvaluateMappingTemplateRequest |
Container for the parameters to the EvaluateMappingTemplate operation. 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). |
|
EvaluateMappingTemplateResponse |
This is the response object from the EvaluateMappingTemplate operation. |
|
EventBridgeDataSourceConfig |
Describes an Amazon EventBridge bus data source configuration. |
|
FlushApiCacheRequest |
Container for the parameters to the FlushApiCache operation.
Flushes an |
|
FlushApiCacheResponse |
Represents the output of a |
|
FunctionConfiguration |
A function is a reusable entity. You can use multiple functions to compose the resolver logic. |
|
GetApiAssociationRequest |
Container for the parameters to the GetApiAssociation operation.
Retrieves an |
|
GetApiAssociationResponse |
This is the response object from the GetApiAssociation operation. |
|
GetApiCacheRequest |
Container for the parameters to the GetApiCache operation.
Retrieves an |
|
GetApiCacheResponse |
Represents the output of a |
|
GetDataSourceIntrospectionRequest |
Container for the parameters to the GetDataSourceIntrospection operation. Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead. |
|
GetDataSourceIntrospectionResponse |
This is the response object from the GetDataSourceIntrospection operation. |
|
GetDataSourceRequest |
Container for the parameters to the GetDataSource operation.
Retrieves a |
|
GetDataSourceResponse |
This is the response object from the GetDataSource operation. |
|
GetDomainNameRequest |
Container for the parameters to the GetDomainName operation.
Retrieves a custom |
|
GetDomainNameResponse |
This is the response object from the GetDomainName operation. |
|
GetFunctionRequest |
Container for the parameters to the GetFunction operation.
Get a |
|
GetFunctionResponse |
This is the response object from the GetFunction operation. |
|
GetGraphqlApiEnvironmentVariablesRequest |
Container for the parameters to the GetGraphqlApiEnvironmentVariables operation. Retrieves the list of environmental variable key-value pairs associated with an API by its ID value. |
|
GetGraphqlApiEnvironmentVariablesResponse |
This is the response object from the GetGraphqlApiEnvironmentVariables operation. |
|
GetGraphqlApiRequest |
Container for the parameters to the GetGraphqlApi operation.
Retrieves a |
|
GetGraphqlApiResponse |
This is the response object from the GetGraphqlApi operation. |
|
GetIntrospectionSchemaRequest |
Container for the parameters to the GetIntrospectionSchema operation. Retrieves the introspection schema for a GraphQL API. |
|
GetIntrospectionSchemaResponse |
This is the response object from the GetIntrospectionSchema operation. |
|
GetResolverRequest |
Container for the parameters to the GetResolver operation.
Retrieves a |
|
GetResolverResponse |
This is the response object from the GetResolver operation. |
|
GetSchemaCreationStatusRequest |
Container for the parameters to the GetSchemaCreationStatus operation. Retrieves the current status of a schema creation operation. |
|
GetSchemaCreationStatusResponse |
This is the response object from the GetSchemaCreationStatus operation. |
|
GetSourceApiAssociationRequest |
Container for the parameters to the GetSourceApiAssociation operation.
Retrieves a |
|
GetSourceApiAssociationResponse |
This is the response object from the GetSourceApiAssociation operation. |
|
GetTypeRequest |
Container for the parameters to the GetType operation.
Retrieves a |
|
GetTypeResponse |
This is the response object from the GetType operation. |
|
GraphqlApi |
Describes a GraphQL API. |
|
GraphQLSchemaException |
The GraphQL schema is not valid. |
|
HttpDataSourceConfig |
Describes an HTTP data source configuration. |
|
InternalFailureException |
An internal AppSync error occurred. Try your request again. |
|
LambdaAuthorizerConfig |
A |
|
LambdaConflictHandlerConfig |
The |
|
LambdaDataSourceConfig |
Describes an Lambda data source configuration. |
|
LimitExceededException |
The request exceeded a limit. Try your request again. |
|
ListApiKeysRequest |
Container for the parameters to the ListApiKeys operation.
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 |
|
ListApiKeysResponse |
This is the response object from the ListApiKeys operation. |
|
ListDataSourcesRequest |
Container for the parameters to the ListDataSources operation. Lists the data sources for a given API. |
|
ListDataSourcesResponse |
This is the response object from the ListDataSources operation. |
|
ListDomainNamesRequest |
Container for the parameters to the ListDomainNames operation. Lists multiple custom domain names. |
|
ListDomainNamesResponse |
This is the response object from the ListDomainNames operation. |
|
ListFunctionsRequest |
Container for the parameters to the ListFunctions operation. List multiple functions. |
|
ListFunctionsResponse |
This is the response object from the ListFunctions operation. |
|
ListGraphqlApisRequest |
Container for the parameters to the ListGraphqlApis operation. Lists your GraphQL APIs. |
|
ListGraphqlApisResponse |
This is the response object from the ListGraphqlApis operation. |
|
ListResolversByFunctionRequest |
Container for the parameters to the ListResolversByFunction operation. List the resolvers that are associated with a specific function. |
|
ListResolversByFunctionResponse |
This is the response object from the ListResolversByFunction operation. |
|
ListResolversRequest |
Container for the parameters to the ListResolvers operation. Lists the resolvers for a given API and type. |
|
ListResolversResponse |
This is the response object from the ListResolvers operation. |
|
ListSourceApiAssociationsRequest |
Container for the parameters to the ListSourceApiAssociations operation.
Lists the |
|
ListSourceApiAssociationsResponse |
This is the response object from the ListSourceApiAssociations operation. |
|
ListTagsForResourceRequest |
Container for the parameters to the ListTagsForResource operation. Lists the tags for a resource. |
|
ListTagsForResourceResponse |
This is the response object from the ListTagsForResource operation. |
|
ListTypesByAssociationRequest |
Container for the parameters to the ListTypesByAssociation operation.
Lists |
|
ListTypesByAssociationResponse |
This is the response object from the ListTypesByAssociation operation. |
|
ListTypesRequest |
Container for the parameters to the ListTypes operation. Lists the types for a given API. |
|
ListTypesResponse |
This is the response object from the ListTypes operation. |
|
LogConfig |
The Amazon CloudWatch Logs configuration. |
|
NotFoundException |
The resource specified in the request was not found. Check the resource, and then try again. |
|
OpenIDConnectConfig |
Describes an OpenID Connect (OIDC) configuration. |
|
OpenSearchServiceDataSourceConfig |
Describes an OpenSearch data source configuration. |
|
PipelineConfig |
The pipeline configuration for a resolver of kind |
|
PutGraphqlApiEnvironmentVariablesRequest |
Container for the parameters to the PutGraphqlApiEnvironmentVariables operation. Creates a list of environmental variables in an API by its ID value. When creating an environmental variable, it must follow the constraints below:
When creating an environmental variable key-value pair, it must follow the additional constraints below:
You can create a list of environmental variables by adding it to the |
|
PutGraphqlApiEnvironmentVariablesResponse |
This is the response object from the PutGraphqlApiEnvironmentVariables operation. |
|
RdsDataApiConfig |
Contains the metadata required to introspect the RDS cluster. |
|
RdsHttpEndpointConfig |
The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration. |
|
RelationalDatabaseDataSourceConfig |
Describes a relational database data source configuration. |
|
Resolver |
Describes a resolver. |
|
SourceApiAssociation |
Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API. There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular API. Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access Manager. For more information about sharing resources from other accounts, see What is Amazon Web Services Resource Access Manager? in the Amazon Web Services Resource Access Manager guide. |
|
SourceApiAssociationConfig |
Describes properties used to specify configurations related to a source API. |
|
SourceApiAssociationSummary |
Describes the ARNs and IDs of associations, Merged APIs, and source APIs. |
|
StartDataSourceIntrospectionRequest |
Container for the parameters to the StartDataSourceIntrospection operation.
Creates a new introspection. Returns the |
|
StartDataSourceIntrospectionResponse |
This is the response object from the StartDataSourceIntrospection operation. |
|
StartSchemaCreationRequest |
Container for the parameters to the StartSchemaCreation operation. Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed. |
|
StartSchemaCreationResponse |
This is the response object from the StartSchemaCreation operation. |
|
StartSchemaMergeRequest |
Container for the parameters to the StartSchemaMerge operation. Initiates a merge operation. Returns a status that shows the result of the merge operation. |
|
StartSchemaMergeResponse |
This is the response object from the StartSchemaMerge operation. |
|
SyncConfig |
Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked. |
|
TagResourceRequest |
Container for the parameters to the TagResource operation. Tags a resource with user-supplied tags. |
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
Type |
Describes a type. |
|
UnauthorizedException |
You aren't authorized to perform this operation. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Untags a resource. |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
UpdateApiCacheRequest |
Container for the parameters to the UpdateApiCache operation. Updates the cache for the GraphQL API. |
|
UpdateApiCacheResponse |
Represents the output of a |
|
UpdateApiKeyRequest |
Container for the parameters to the UpdateApiKey operation. Updates an API key. You can update the key as long as it's not deleted. |
|
UpdateApiKeyResponse |
This is the response object from the UpdateApiKey operation. |
|
UpdateDataSourceRequest |
Container for the parameters to the UpdateDataSource operation.
Updates a |
|
UpdateDataSourceResponse |
This is the response object from the UpdateDataSource operation. |
|
UpdateDomainNameRequest |
Container for the parameters to the UpdateDomainName operation.
Updates a custom |
|
UpdateDomainNameResponse |
This is the response object from the UpdateDomainName operation. |
|
UpdateFunctionRequest |
Container for the parameters to the UpdateFunction operation.
Updates a |
|
UpdateFunctionResponse |
This is the response object from the UpdateFunction operation. |
|
UpdateGraphqlApiRequest |
Container for the parameters to the UpdateGraphqlApi operation.
Updates a |
|
UpdateGraphqlApiResponse |
This is the response object from the UpdateGraphqlApi operation. |
|
UpdateResolverRequest |
Container for the parameters to the UpdateResolver operation.
Updates a |
|
UpdateResolverResponse |
This is the response object from the UpdateResolver operation. |
|
UpdateSourceApiAssociationRequest |
Container for the parameters to the UpdateSourceApiAssociation operation. Updates some of the configuration choices of a particular source API association. |
|
UpdateSourceApiAssociationResponse |
This is the response object from the UpdateSourceApiAssociation operation. |
|
UpdateTypeRequest |
Container for the parameters to the UpdateType operation.
Updates a |
|
UpdateTypeResponse |
This is the response object from the UpdateType operation. |
|
UserPoolConfig |
Describes an Amazon Cognito user pool configuration. |