{ "version":"2.0", "metadata":{ "apiVersion":"2017-07-25", "endpointPrefix":"appsync", "jsonVersion":"1.1", "protocol":"rest-json", "serviceAbbreviation":"AWSAppSync", "serviceFullName":"AWS AppSync", "serviceId":"AppSync", "signatureVersion":"v4", "signingName":"appsync", "uid":"appsync-2017-07-25" }, "operations":{ "AssociateApi":{ "name":"AssociateApi", "http":{ "method":"POST", "requestUri":"/v1/domainnames/{domainName}/apiassociation" }, "input":{"shape":"AssociateApiRequest"}, "output":{"shape":"AssociateApiResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"} ], "documentation":"

Maps an endpoint to your custom domain.

" }, "AssociateMergedGraphqlApi":{ "name":"AssociateMergedGraphqlApi", "http":{ "method":"POST", "requestUri":"/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations" }, "input":{"shape":"AssociateMergedGraphqlApiRequest"}, "output":{"shape":"AssociateMergedGraphqlApiResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Creates an association between a Merged API and source API using the source API's identifier.

" }, "AssociateSourceGraphqlApi":{ "name":"AssociateSourceGraphqlApi", "http":{ "method":"POST", "requestUri":"/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations" }, "input":{"shape":"AssociateSourceGraphqlApiRequest"}, "output":{"shape":"AssociateSourceGraphqlApiResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Creates an association between a Merged API and source API using the Merged API's identifier.

" }, "CreateApiCache":{ "name":"CreateApiCache", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/ApiCaches" }, "input":{"shape":"CreateApiCacheRequest"}, "output":{"shape":"CreateApiCacheResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Creates a cache for the GraphQL API.

" }, "CreateApiKey":{ "name":"CreateApiKey", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/apikeys" }, "input":{"shape":"CreateApiKeyRequest"}, "output":{"shape":"CreateApiKeyResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"UnauthorizedException"}, {"shape":"LimitExceededException"}, {"shape":"InternalFailureException"}, {"shape":"ApiKeyLimitExceededException"}, {"shape":"ApiKeyValidityOutOfBoundsException"} ], "documentation":"

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

" }, "CreateDataSource":{ "name":"CreateDataSource", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/datasources" }, "input":{"shape":"CreateDataSourceRequest"}, "output":{"shape":"CreateDataSourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Creates a `DataSource` object.

" }, "CreateDomainName":{ "name":"CreateDomainName", "http":{ "method":"POST", "requestUri":"/v1/domainnames" }, "input":{"shape":"CreateDomainNameRequest"}, "output":{"shape":"CreateDomainNameResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"} ], "documentation":"

Creates a custom `DomainName` object.

" }, "CreateFunction":{ "name":"CreateFunction", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/functions" }, "input":{"shape":"CreateFunctionRequest"}, "output":{"shape":"CreateFunctionResponse"}, "errors":[ {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Creates a `Function` object.

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

" }, "CreateGraphqlApi":{ "name":"CreateGraphqlApi", "http":{ "method":"POST", "requestUri":"/v1/apis" }, "input":{"shape":"CreateGraphqlApiRequest"}, "output":{"shape":"CreateGraphqlApiResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"LimitExceededException"}, {"shape":"ConcurrentModificationException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"ApiLimitExceededException"} ], "documentation":"

Creates a `GraphqlApi` object.

" }, "CreateResolver":{ "name":"CreateResolver", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/types/{typeName}/resolvers" }, "input":{"shape":"CreateResolverRequest"}, "output":{"shape":"CreateResolverResponse"}, "errors":[ {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"BadRequestException"} ], "documentation":"

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.

" }, "CreateType":{ "name":"CreateType", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/types" }, "input":{"shape":"CreateTypeRequest"}, "output":{"shape":"CreateTypeResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Creates a `Type` object.

" }, "DeleteApiCache":{ "name":"DeleteApiCache", "http":{ "method":"DELETE", "requestUri":"/v1/apis/{apiId}/ApiCaches" }, "input":{"shape":"DeleteApiCacheRequest"}, "output":{"shape":"DeleteApiCacheResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Deletes an `ApiCache` object.

" }, "DeleteApiKey":{ "name":"DeleteApiKey", "http":{ "method":"DELETE", "requestUri":"/v1/apis/{apiId}/apikeys/{id}" }, "input":{"shape":"DeleteApiKeyRequest"}, "output":{"shape":"DeleteApiKeyResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Deletes an API key.

" }, "DeleteDataSource":{ "name":"DeleteDataSource", "http":{ "method":"DELETE", "requestUri":"/v1/apis/{apiId}/datasources/{name}" }, "input":{"shape":"DeleteDataSourceRequest"}, "output":{"shape":"DeleteDataSourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Deletes a `DataSource` object.

" }, "DeleteDomainName":{ "name":"DeleteDomainName", "http":{ "method":"DELETE", "requestUri":"/v1/domainnames/{domainName}" }, "input":{"shape":"DeleteDomainNameRequest"}, "output":{"shape":"DeleteDomainNameResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"} ], "documentation":"

Deletes a custom `DomainName` object.

" }, "DeleteFunction":{ "name":"DeleteFunction", "http":{ "method":"DELETE", "requestUri":"/v1/apis/{apiId}/functions/{functionId}" }, "input":{"shape":"DeleteFunctionRequest"}, "output":{"shape":"DeleteFunctionResponse"}, "errors":[ {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Deletes a `Function`.

" }, "DeleteGraphqlApi":{ "name":"DeleteGraphqlApi", "http":{ "method":"DELETE", "requestUri":"/v1/apis/{apiId}" }, "input":{"shape":"DeleteGraphqlApiRequest"}, "output":{"shape":"DeleteGraphqlApiResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Deletes a `GraphqlApi` object.

" }, "DeleteResolver":{ "name":"DeleteResolver", "http":{ "method":"DELETE", "requestUri":"/v1/apis/{apiId}/types/{typeName}/resolvers/{fieldName}" }, "input":{"shape":"DeleteResolverRequest"}, "output":{"shape":"DeleteResolverResponse"}, "errors":[ {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"BadRequestException"} ], "documentation":"

Deletes a `Resolver` object.

" }, "DeleteType":{ "name":"DeleteType", "http":{ "method":"DELETE", "requestUri":"/v1/apis/{apiId}/types/{typeName}" }, "input":{"shape":"DeleteTypeRequest"}, "output":{"shape":"DeleteTypeResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Deletes a `Type` object.

" }, "DisassociateApi":{ "name":"DisassociateApi", "http":{ "method":"DELETE", "requestUri":"/v1/domainnames/{domainName}/apiassociation" }, "input":{"shape":"DisassociateApiRequest"}, "output":{"shape":"DisassociateApiResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"} ], "documentation":"

Removes an `ApiAssociation` object from a custom domain.

" }, "DisassociateMergedGraphqlApi":{ "name":"DisassociateMergedGraphqlApi", "http":{ "method":"DELETE", "requestUri":"/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations/{associationId}" }, "input":{"shape":"DisassociateMergedGraphqlApiRequest"}, "output":{"shape":"DisassociateMergedGraphqlApiResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Deletes an association between a Merged API and source API using the source API's identifier and the association ID.

" }, "DisassociateSourceGraphqlApi":{ "name":"DisassociateSourceGraphqlApi", "http":{ "method":"DELETE", "requestUri":"/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}" }, "input":{"shape":"DisassociateSourceGraphqlApiRequest"}, "output":{"shape":"DisassociateSourceGraphqlApiResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.

" }, "EvaluateCode":{ "name":"EvaluateCode", "http":{ "method":"POST", "requestUri":"/v1/dataplane-evaluatecode" }, "input":{"shape":"EvaluateCodeRequest"}, "output":{"shape":"EvaluateCodeResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalFailureException"}, {"shape":"BadRequestException"} ], "documentation":"

Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For `APPSYNC_JS` runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type.

" }, "EvaluateMappingTemplate":{ "name":"EvaluateMappingTemplate", "http":{ "method":"POST", "requestUri":"/v1/dataplane-evaluatetemplate" }, "input":{"shape":"EvaluateMappingTemplateRequest"}, "output":{"shape":"EvaluateMappingTemplateResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalFailureException"}, {"shape":"BadRequestException"} ], "documentation":"

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

" }, "FlushApiCache":{ "name":"FlushApiCache", "http":{ "method":"DELETE", "requestUri":"/v1/apis/{apiId}/FlushCache" }, "input":{"shape":"FlushApiCacheRequest"}, "output":{"shape":"FlushApiCacheResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Flushes an `ApiCache` object.

" }, "GetApiAssociation":{ "name":"GetApiAssociation", "http":{ "method":"GET", "requestUri":"/v1/domainnames/{domainName}/apiassociation" }, "input":{"shape":"GetApiAssociationRequest"}, "output":{"shape":"GetApiAssociationResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"} ], "documentation":"

Retrieves an `ApiAssociation` object.

" }, "GetApiCache":{ "name":"GetApiCache", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/ApiCaches" }, "input":{"shape":"GetApiCacheRequest"}, "output":{"shape":"GetApiCacheResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Retrieves an `ApiCache` object.

" }, "GetDataSource":{ "name":"GetDataSource", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/datasources/{name}" }, "input":{"shape":"GetDataSourceRequest"}, "output":{"shape":"GetDataSourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Retrieves a `DataSource` object.

" }, "GetDataSourceIntrospection":{ "name":"GetDataSourceIntrospection", "http":{ "method":"GET", "requestUri":"/v1/datasources/introspections/{introspectionId}" }, "input":{"shape":"GetDataSourceIntrospectionRequest"}, "output":{"shape":"GetDataSourceIntrospectionResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"} ], "documentation":"

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.

" }, "GetDomainName":{ "name":"GetDomainName", "http":{ "method":"GET", "requestUri":"/v1/domainnames/{domainName}" }, "input":{"shape":"GetDomainNameRequest"}, "output":{"shape":"GetDomainNameResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"} ], "documentation":"

Retrieves a custom `DomainName` object.

" }, "GetFunction":{ "name":"GetFunction", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/functions/{functionId}" }, "input":{"shape":"GetFunctionRequest"}, "output":{"shape":"GetFunctionResponse"}, "errors":[ {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Get a `Function`.

" }, "GetGraphqlApi":{ "name":"GetGraphqlApi", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}" }, "input":{"shape":"GetGraphqlApiRequest"}, "output":{"shape":"GetGraphqlApiResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Retrieves a `GraphqlApi` object.

" }, "GetIntrospectionSchema":{ "name":"GetIntrospectionSchema", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/schema" }, "input":{"shape":"GetIntrospectionSchemaRequest"}, "output":{"shape":"GetIntrospectionSchemaResponse"}, "errors":[ {"shape":"GraphQLSchemaException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Retrieves the introspection schema for a GraphQL API.

" }, "GetResolver":{ "name":"GetResolver", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/types/{typeName}/resolvers/{fieldName}" }, "input":{"shape":"GetResolverRequest"}, "output":{"shape":"GetResolverResponse"}, "errors":[ {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Retrieves a `Resolver` object.

" }, "GetSchemaCreationStatus":{ "name":"GetSchemaCreationStatus", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/schemacreation" }, "input":{"shape":"GetSchemaCreationStatusRequest"}, "output":{"shape":"GetSchemaCreationStatusResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Retrieves the current status of a schema creation operation.

" }, "GetSourceApiAssociation":{ "name":"GetSourceApiAssociation", "http":{ "method":"GET", "requestUri":"/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}" }, "input":{"shape":"GetSourceApiAssociationRequest"}, "output":{"shape":"GetSourceApiAssociationResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"} ], "documentation":"

Retrieves a `SourceApiAssociation` object.

" }, "GetType":{ "name":"GetType", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/types/{typeName}" }, "input":{"shape":"GetTypeRequest"}, "output":{"shape":"GetTypeResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Retrieves a `Type` object.

" }, "ListApiKeys":{ "name":"ListApiKeys", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/apikeys" }, "input":{"shape":"ListApiKeysRequest"}, "output":{"shape":"ListApiKeysResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Lists the API keys for a given API.

API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call `DeleteApiKey` to manually delete a key before it's automatically deleted.

" }, "ListDataSources":{ "name":"ListDataSources", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/datasources" }, "input":{"shape":"ListDataSourcesRequest"}, "output":{"shape":"ListDataSourcesResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Lists the data sources for a given API.

" }, "ListDomainNames":{ "name":"ListDomainNames", "http":{ "method":"GET", "requestUri":"/v1/domainnames" }, "input":{"shape":"ListDomainNamesRequest"}, "output":{"shape":"ListDomainNamesResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"} ], "documentation":"

Lists multiple custom domain names.

" }, "ListFunctions":{ "name":"ListFunctions", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/functions" }, "input":{"shape":"ListFunctionsRequest"}, "output":{"shape":"ListFunctionsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

List multiple functions.

" }, "ListGraphqlApis":{ "name":"ListGraphqlApis", "http":{ "method":"GET", "requestUri":"/v1/apis" }, "input":{"shape":"ListGraphqlApisRequest"}, "output":{"shape":"ListGraphqlApisResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Lists your GraphQL APIs.

" }, "ListResolvers":{ "name":"ListResolvers", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/types/{typeName}/resolvers" }, "input":{"shape":"ListResolversRequest"}, "output":{"shape":"ListResolversResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Lists the resolvers for a given API and type.

" }, "ListResolversByFunction":{ "name":"ListResolversByFunction", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/functions/{functionId}/resolvers" }, "input":{"shape":"ListResolversByFunctionRequest"}, "output":{"shape":"ListResolversByFunctionResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

List the resolvers that are associated with a specific function.

" }, "ListSourceApiAssociations":{ "name":"ListSourceApiAssociations", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/sourceApiAssociations" }, "input":{"shape":"ListSourceApiAssociationsRequest"}, "output":{"shape":"ListSourceApiAssociationsResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"} ], "documentation":"

Lists the `SourceApiAssociationSummary` data.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/v1/tags/{resourceArn}" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists the tags for a resource.

" }, "ListTypes":{ "name":"ListTypes", "http":{ "method":"GET", "requestUri":"/v1/apis/{apiId}/types" }, "input":{"shape":"ListTypesRequest"}, "output":{"shape":"ListTypesResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Lists the types for a given API.

" }, "ListTypesByAssociation":{ "name":"ListTypesByAssociation", "http":{ "method":"GET", "requestUri":"/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}/types" }, "input":{"shape":"ListTypesByAssociationRequest"}, "output":{"shape":"ListTypesByAssociationResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Lists `Type` objects by the source API association ID.

" }, "StartDataSourceIntrospection":{ "name":"StartDataSourceIntrospection", "http":{ "method":"POST", "requestUri":"/v1/datasources/introspections" }, "input":{"shape":"StartDataSourceIntrospectionRequest"}, "output":{"shape":"StartDataSourceIntrospectionResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"BadRequestException"} ], "documentation":"

Creates a new introspection. Returns the `introspectionId` of the new introspection after its creation.

" }, "StartSchemaCreation":{ "name":"StartSchemaCreation", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/schemacreation" }, "input":{"shape":"StartSchemaCreationRequest"}, "output":{"shape":"StartSchemaCreationResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Adds a new schema to your GraphQL API.

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

" }, "StartSchemaMerge":{ "name":"StartSchemaMerge", "http":{ "method":"POST", "requestUri":"/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}/merge" }, "input":{"shape":"StartSchemaMergeRequest"}, "output":{"shape":"StartSchemaMergeResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Initiates a merge operation. Returns a status that shows the result of the merge operation.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/v1/tags/{resourceArn}" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Tags a resource with user-supplied tags.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/v1/tags/{resourceArn}" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Untags a resource.

" }, "UpdateApiCache":{ "name":"UpdateApiCache", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/ApiCaches/update" }, "input":{"shape":"UpdateApiCacheRequest"}, "output":{"shape":"UpdateApiCacheResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Updates the cache for the GraphQL API.

" }, "UpdateApiKey":{ "name":"UpdateApiKey", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/apikeys/{id}" }, "input":{"shape":"UpdateApiKeyRequest"}, "output":{"shape":"UpdateApiKeyResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"LimitExceededException"}, {"shape":"InternalFailureException"}, {"shape":"ApiKeyValidityOutOfBoundsException"} ], "documentation":"

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

" }, "UpdateDataSource":{ "name":"UpdateDataSource", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/datasources/{name}" }, "input":{"shape":"UpdateDataSourceRequest"}, "output":{"shape":"UpdateDataSourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Updates a `DataSource` object.

" }, "UpdateDomainName":{ "name":"UpdateDomainName", "http":{ "method":"POST", "requestUri":"/v1/domainnames/{domainName}" }, "input":{"shape":"UpdateDomainNameRequest"}, "output":{"shape":"UpdateDomainNameResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"} ], "documentation":"

Updates a custom `DomainName` object.

" }, "UpdateFunction":{ "name":"UpdateFunction", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/functions/{functionId}" }, "input":{"shape":"UpdateFunctionRequest"}, "output":{"shape":"UpdateFunctionResponse"}, "errors":[ {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Updates a `Function` object.

" }, "UpdateGraphqlApi":{ "name":"UpdateGraphqlApi", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}" }, "input":{"shape":"UpdateGraphqlApiRequest"}, "output":{"shape":"UpdateGraphqlApiResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Updates a `GraphqlApi` object.

" }, "UpdateResolver":{ "name":"UpdateResolver", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/types/{typeName}/resolvers/{fieldName}" }, "input":{"shape":"UpdateResolverRequest"}, "output":{"shape":"UpdateResolverResponse"}, "errors":[ {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"BadRequestException"} ], "documentation":"

Updates a `Resolver` object.

" }, "UpdateSourceApiAssociation":{ "name":"UpdateSourceApiAssociation", "http":{ "method":"POST", "requestUri":"/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}" }, "input":{"shape":"UpdateSourceApiAssociationRequest"}, "output":{"shape":"UpdateSourceApiAssociationResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Updates some of the configuration choices of a particular source API association.

" }, "UpdateType":{ "name":"UpdateType", "http":{ "method":"POST", "requestUri":"/v1/apis/{apiId}/types/{typeName}" }, "input":{"shape":"UpdateTypeRequest"}, "output":{"shape":"UpdateTypeResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConcurrentModificationException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"

Updates a `Type` object.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

You don't have access to perform this operation on this resource.

", "error":{"httpStatusCode":403}, "exception":true }, "AdditionalAuthenticationProvider":{ "type":"structure", "members":{ "authenticationType":{ "shape":"AuthenticationType", "documentation":"

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

" }, "openIDConnectConfig":{ "shape":"OpenIDConnectConfig", "documentation":"

The OIDC configuration.

" }, "userPoolConfig":{ "shape":"CognitoUserPoolConfig", "documentation":"

The Amazon Cognito user pool configuration.

" }, "lambdaAuthorizerConfig":{ "shape":"LambdaAuthorizerConfig", "documentation":"

Configuration for Lambda function authorization.

" } }, "documentation":"

Describes an additional authentication provider.

" }, "AdditionalAuthenticationProviders":{ "type":"list", "member":{"shape":"AdditionalAuthenticationProvider"} }, "ApiAssociation":{ "type":"structure", "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name.

" }, "apiId":{ "shape":"String", "documentation":"

The API ID.

" }, "associationStatus":{ "shape":"AssociationStatus", "documentation":"

Identifies the status of an association.

- PROCESSING: The API association is being created. You cannot modify association requests during processing.

- SUCCESS: The API association was successful. You can modify associations after success.

- FAILED: The API association has failed. You can modify associations after failure.

" }, "deploymentDetail":{ "shape":"String", "documentation":"

Details about the last deployment status.

" } }, "documentation":"

Describes an `ApiAssociation` object.

" }, "ApiCache":{ "type":"structure", "members":{ "ttl":{ "shape":"Long", "documentation":"

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

" }, "apiCachingBehavior":{ "shape":"ApiCachingBehavior", "documentation":"

Caching behavior.

- FULL_REQUEST_CACHING: All requests are fully cached.

- PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

" }, "transitEncryptionEnabled":{ "shape":"Boolean", "documentation":"

Transit encryption flag when connecting to cache. You cannot update this setting after creation.

" }, "atRestEncryptionEnabled":{ "shape":"Boolean", "documentation":"

At-rest encryption flag for cache. You cannot update this setting after creation.

" }, "type":{ "shape":"ApiCacheType", "documentation":"

The cache instance type. Valid values are

- `SMALL`

- `MEDIUM`

- `LARGE`

- `XLARGE`

- `LARGE_2X`

- `LARGE_4X`

- `LARGE_8X` (not available in all regions)

- `LARGE_12X`

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

- T2_SMALL: A t2.small instance type.

- T2_MEDIUM: A t2.medium instance type.

- R4_LARGE: A r4.large instance type.

- R4_XLARGE: A r4.xlarge instance type.

- R4_2XLARGE: A r4.2xlarge instance type.

- R4_4XLARGE: A r4.4xlarge instance type.

- R4_8XLARGE: A r4.8xlarge instance type.

" }, "status":{ "shape":"ApiCacheStatus", "documentation":"

The cache instance status.

- AVAILABLE: The instance is available for use.

- CREATING: The instance is currently creating.

- DELETING: The instance is currently deleting.

- MODIFYING: The instance is currently modifying.

- FAILED: The instance has failed creation.

" } }, "documentation":"

The `ApiCache` object.

" }, "ApiCacheStatus":{ "type":"string", "enum":[ "AVAILABLE", "CREATING", "DELETING", "MODIFYING", "FAILED" ] }, "ApiCacheType":{ "type":"string", "enum":[ "T2_SMALL", "T2_MEDIUM", "R4_LARGE", "R4_XLARGE", "R4_2XLARGE", "R4_4XLARGE", "R4_8XLARGE", "SMALL", "MEDIUM", "LARGE", "XLARGE", "LARGE_2X", "LARGE_4X", "LARGE_8X", "LARGE_12X" ] }, "ApiCachingBehavior":{ "type":"string", "enum":[ "FULL_REQUEST_CACHING", "PER_RESOLVER_CACHING" ] }, "ApiKey":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The API key ID.

" }, "description":{ "shape":"String", "documentation":"

A description of the purpose of the API key.

" }, "expires":{ "shape":"Long", "documentation":"

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

" }, "deletes":{ "shape":"Long", "documentation":"

The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.

" } }, "documentation":"

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.

- `ListApiKeys` returns the expiration time in milliseconds.

- `CreateApiKey` returns the expiration time in milliseconds.

- `UpdateApiKey` is not available for this key version.

- `DeleteApiKey` deletes the item from the table.

- Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we deleted these keys from the table on February 21, 2018.

da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.

- `ListApiKeys` returns the expiration time and deletion time in seconds.

- `CreateApiKey` returns the expiration time and deletion time in seconds and accepts a user-provided expiration time in seconds.

- `UpdateApiKey` returns the expiration time and and deletion time in seconds and accepts a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration time. You can update the key expiration time as long as the key isn't deleted.

- `DeleteApiKey` deletes the item from the table.

- Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. However, you can reinstate the key before deletion.

- Deletion is stored in DynamoDB as seconds. The key is deleted after deletion time.

" }, "ApiKeyLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The API key exceeded a limit. Try your request again.

", "error":{"httpStatusCode":400}, "exception":true }, "ApiKeyValidityOutOfBoundsException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The API key expiration must be set to a value between 1 and 365 days from creation (for `CreateApiKey`) or from update (for `UpdateApiKey`).

", "error":{"httpStatusCode":400}, "exception":true }, "ApiKeys":{ "type":"list", "member":{"shape":"ApiKey"} }, "ApiLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The GraphQL API exceeded a limit. Try your request again.

", "error":{"httpStatusCode":400}, "exception":true }, "AppSyncRuntime":{ "type":"structure", "required":[ "name", "runtimeVersion" ], "members":{ "name":{ "shape":"RuntimeName", "documentation":"

The `name` of the runtime to use. Currently, the only allowed value is `APPSYNC_JS`.

" }, "runtimeVersion":{ "shape":"String", "documentation":"

The `version` of the runtime to use. Currently, the only allowed version is `1.0.0`.

" } }, "documentation":"

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":{ "type":"structure", "required":[ "domainName", "apiId" ], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name.

", "location":"uri", "locationName":"domainName" }, "apiId":{ "shape":"String", "documentation":"

The API ID. Private APIs can not be associated with custom domains.

" } } }, "AssociateApiResponse":{ "type":"structure", "members":{ "apiAssociation":{ "shape":"ApiAssociation", "documentation":"

The `ApiAssociation` object.

" } } }, "AssociateMergedGraphqlApiRequest":{ "type":"structure", "required":[ "sourceApiIdentifier", "mergedApiIdentifier" ], "members":{ "sourceApiIdentifier":{ "shape":"String", "documentation":"

The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.

", "location":"uri", "locationName":"sourceApiIdentifier" }, "mergedApiIdentifier":{ "shape":"String", "documentation":"

The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

" }, "description":{ "shape":"String", "documentation":"

The description field.

" }, "sourceApiAssociationConfig":{ "shape":"SourceApiAssociationConfig", "documentation":"

The `SourceApiAssociationConfig` object data.

" } } }, "AssociateMergedGraphqlApiResponse":{ "type":"structure", "members":{ "sourceApiAssociation":{ "shape":"SourceApiAssociation", "documentation":"

The `SourceApiAssociation` object data.

" } } }, "AssociateSourceGraphqlApiRequest":{ "type":"structure", "required":[ "mergedApiIdentifier", "sourceApiIdentifier" ], "members":{ "mergedApiIdentifier":{ "shape":"String", "documentation":"

The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

", "location":"uri", "locationName":"mergedApiIdentifier" }, "sourceApiIdentifier":{ "shape":"String", "documentation":"

The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.

" }, "description":{ "shape":"String", "documentation":"

The description field.

" }, "sourceApiAssociationConfig":{ "shape":"SourceApiAssociationConfig", "documentation":"

The `SourceApiAssociationConfig` object data.

" } } }, "AssociateSourceGraphqlApiResponse":{ "type":"structure", "members":{ "sourceApiAssociation":{ "shape":"SourceApiAssociation", "documentation":"

The `SourceApiAssociation` object data.

" } } }, "AssociationStatus":{ "type":"string", "enum":[ "PROCESSING", "FAILED", "SUCCESS" ] }, "AuthenticationType":{ "type":"string", "enum":[ "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS", "OPENID_CONNECT", "AWS_LAMBDA" ] }, "AuthorizationConfig":{ "type":"structure", "required":["authorizationType"], "members":{ "authorizationType":{ "shape":"AuthorizationType", "documentation":"

The authorization type that the HTTP endpoint requires.

- AWS_IAM: The authorization type is Signature Version 4 (SigV4).

" }, "awsIamConfig":{ "shape":"AwsIamConfig", "documentation":"

The Identity and Access Management (IAM) settings.

" } }, "documentation":"

The authorization configuration in case the HTTP endpoint requires authorization.

" }, "AuthorizationType":{ "type":"string", "enum":["AWS_IAM"] }, "AwsIamConfig":{ "type":"structure", "members":{ "signingRegion":{ "shape":"String", "documentation":"

The signing Amazon Web Services Region for IAM authorization.

" }, "signingServiceName":{ "shape":"String", "documentation":"

The signing service name for IAM authorization.

" } }, "documentation":"

The Identity and Access Management (IAM) configuration.

" }, "BadRequestDetail":{ "type":"structure", "members":{ "codeErrors":{ "shape":"CodeErrors", "documentation":"

Contains the list of errors in the request.

" } }, "documentation":"

Provides further details for the reason behind the bad request. For reason type `CODE_ERROR`, the detail will contain a list of code errors.

" }, "BadRequestException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"}, "reason":{"shape":"BadRequestReason"}, "detail":{"shape":"BadRequestDetail"} }, "documentation":"

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.

", "error":{"httpStatusCode":400}, "exception":true }, "BadRequestReason":{ "type":"string", "documentation":"

Provides context for the cause of the bad request. The only supported value is `CODE_ERROR`.

", "enum":["CODE_ERROR"] }, "Blob":{"type":"blob"}, "Boolean":{"type":"boolean"}, "BooleanValue":{"type":"boolean"}, "CachingConfig":{ "type":"structure", "required":["ttl"], "members":{ "ttl":{ "shape":"Long", "documentation":"

The TTL in seconds for a resolver that has caching activated.

Valid values are 1–3,600 seconds.

" }, "cachingKeys":{ "shape":"CachingKeys", "documentation":"

The caching keys for a resolver that has caching activated.

Valid values are entries from the `$context.arguments`, `$context.source`, and `$context.identity` maps.

" } }, "documentation":"

The caching configuration for a resolver that has caching activated.

" }, "CachingKeys":{ "type":"list", "member":{"shape":"String"} }, "CertificateArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:[a-z-]*:(acm|iam):[a-z0-9-]*:\\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$" }, "Code":{ "type":"string", "max":32768, "min":1 }, "CodeError":{ "type":"structure", "members":{ "errorType":{ "shape":"String", "documentation":"

The type of code error.

Examples include, but aren't limited to: `LINT_ERROR`, `PARSER_ERROR`.

" }, "value":{ "shape":"String", "documentation":"

A user presentable error.

Examples include, but aren't limited to: `Parsing error: Unterminated string literal`.

" }, "location":{ "shape":"CodeErrorLocation", "documentation":"

The line, column, and span location of the error in the code.

" } }, "documentation":"

Describes an AppSync error.

" }, "CodeErrorColumn":{"type":"integer"}, "CodeErrorLine":{"type":"integer"}, "CodeErrorLocation":{ "type":"structure", "members":{ "line":{ "shape":"CodeErrorLine", "documentation":"

The line number in the code. Defaults to `0` if unknown.

" }, "column":{ "shape":"CodeErrorColumn", "documentation":"

The column number in the code. Defaults to `0` if unknown.

" }, "span":{ "shape":"CodeErrorSpan", "documentation":"

The span/length of the error. Defaults to `-1` if unknown.

" } }, "documentation":"

Describes the location of the error in a code sample.

" }, "CodeErrorSpan":{"type":"integer"}, "CodeErrors":{ "type":"list", "member":{"shape":"CodeError"} }, "CognitoUserPoolConfig":{ "type":"structure", "required":[ "userPoolId", "awsRegion" ], "members":{ "userPoolId":{ "shape":"String", "documentation":"

The user pool ID.

" }, "awsRegion":{ "shape":"String", "documentation":"

The Amazon Web Services Region in which the user pool was created.

" }, "appIdClientRegex":{ "shape":"String", "documentation":"

A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

" } }, "documentation":"

Describes an Amazon Cognito user pool configuration.

" }, "ConcurrentModificationException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

Another modification is in progress at this time and it must complete before you can make your change.

", "error":{"httpStatusCode":409}, "exception":true }, "ConflictDetectionType":{ "type":"string", "enum":[ "VERSION", "NONE" ] }, "ConflictHandlerType":{ "type":"string", "enum":[ "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE" ] }, "Context":{ "type":"string", "max":28000, "min":2, "pattern":"^[\\s\\S]*$" }, "CreateApiCacheRequest":{ "type":"structure", "required":[ "apiId", "ttl", "apiCachingBehavior", "type" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The GraphQL API ID.

", "location":"uri", "locationName":"apiId" }, "ttl":{ "shape":"Long", "documentation":"

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

" }, "transitEncryptionEnabled":{ "shape":"Boolean", "documentation":"

Transit encryption flag when connecting to cache. You cannot update this setting after creation.

" }, "atRestEncryptionEnabled":{ "shape":"Boolean", "documentation":"

At-rest encryption flag for cache. You cannot update this setting after creation.

" }, "apiCachingBehavior":{ "shape":"ApiCachingBehavior", "documentation":"

Caching behavior.

- FULL_REQUEST_CACHING: All requests are fully cached.

- PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

" }, "type":{ "shape":"ApiCacheType", "documentation":"

The cache instance type. Valid values are

- `SMALL`

- `MEDIUM`

- `LARGE`

- `XLARGE`

- `LARGE_2X`

- `LARGE_4X`

- `LARGE_8X` (not available in all regions)

- `LARGE_12X`

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

- T2_SMALL: A t2.small instance type.

- T2_MEDIUM: A t2.medium instance type.

- R4_LARGE: A r4.large instance type.

- R4_XLARGE: A r4.xlarge instance type.

- R4_2XLARGE: A r4.2xlarge instance type.

- R4_4XLARGE: A r4.4xlarge instance type.

- R4_8XLARGE: A r4.8xlarge instance type.

" } }, "documentation":"

Represents the input of a `CreateApiCache` operation.

" }, "CreateApiCacheResponse":{ "type":"structure", "members":{ "apiCache":{ "shape":"ApiCache", "documentation":"

The `ApiCache` object.

" } }, "documentation":"

Represents the output of a `CreateApiCache` operation.

" }, "CreateApiKeyRequest":{ "type":"structure", "required":["apiId"], "members":{ "apiId":{ "shape":"String", "documentation":"

The ID for your GraphQL API.

", "location":"uri", "locationName":"apiId" }, "description":{ "shape":"String", "documentation":"

A description of the purpose of the API key.

" }, "expires":{ "shape":"Long", "documentation":"

From the creation time, the time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .

" } } }, "CreateApiKeyResponse":{ "type":"structure", "members":{ "apiKey":{ "shape":"ApiKey", "documentation":"

The API key.

" } } }, "CreateDataSourceRequest":{ "type":"structure", "required":[ "apiId", "name", "type" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID for the GraphQL API for the `DataSource`.

", "location":"uri", "locationName":"apiId" }, "name":{ "shape":"ResourceName", "documentation":"

A user-supplied name for the `DataSource`.

" }, "description":{ "shape":"String", "documentation":"

A description of the `DataSource`.

" }, "type":{ "shape":"DataSourceType", "documentation":"

The type of the `DataSource`.

" }, "serviceRoleArn":{ "shape":"String", "documentation":"

The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.

" }, "dynamodbConfig":{ "shape":"DynamodbDataSourceConfig", "documentation":"

Amazon DynamoDB settings.

" }, "lambdaConfig":{ "shape":"LambdaDataSourceConfig", "documentation":"

Lambda settings.

" }, "elasticsearchConfig":{ "shape":"ElasticsearchDataSourceConfig", "documentation":"

Amazon OpenSearch Service settings.

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.

" }, "openSearchServiceConfig":{ "shape":"OpenSearchServiceDataSourceConfig", "documentation":"

Amazon OpenSearch Service settings.

" }, "httpConfig":{ "shape":"HttpDataSourceConfig", "documentation":"

HTTP endpoint settings.

" }, "relationalDatabaseConfig":{ "shape":"RelationalDatabaseDataSourceConfig", "documentation":"

Relational database settings.

" }, "eventBridgeConfig":{ "shape":"EventBridgeDataSourceConfig", "documentation":"

Amazon EventBridge settings.

" } } }, "CreateDataSourceResponse":{ "type":"structure", "members":{ "dataSource":{ "shape":"DataSource", "documentation":"

The `DataSource` object.

" } } }, "CreateDomainNameRequest":{ "type":"structure", "required":[ "domainName", "certificateArn" ], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name.

" }, "certificateArn":{ "shape":"CertificateArn", "documentation":"

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.

" }, "description":{ "shape":"Description", "documentation":"

A description of the `DomainName`.

" } } }, "CreateDomainNameResponse":{ "type":"structure", "members":{ "domainNameConfig":{ "shape":"DomainNameConfig", "documentation":"

The configuration for the `DomainName`.

" } } }, "CreateFunctionRequest":{ "type":"structure", "required":[ "apiId", "name", "dataSourceName" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The GraphQL API ID.

", "location":"uri", "locationName":"apiId" }, "name":{ "shape":"ResourceName", "documentation":"

The `Function` name. The function name does not have to be unique.

" }, "description":{ "shape":"String", "documentation":"

The `Function` description.

" }, "dataSourceName":{ "shape":"ResourceName", "documentation":"

The `Function` `DataSource` name.

" }, "requestMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The `Function` request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

" }, "responseMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The `Function` response mapping template.

" }, "functionVersion":{ "shape":"String", "documentation":"

The `version` of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the `functionVersion` is required.

" }, "syncConfig":{"shape":"SyncConfig"}, "maxBatchSize":{ "shape":"MaxBatchSize", "documentation":"

The maximum batching size for a resolver.

" }, "runtime":{"shape":"AppSyncRuntime"}, "code":{ "shape":"Code", "documentation":"

The `function` code that contains the request and response functions. When code is used, the `runtime` is required. The `runtime` value must be `APPSYNC_JS`.

" } } }, "CreateFunctionResponse":{ "type":"structure", "members":{ "functionConfiguration":{ "shape":"FunctionConfiguration", "documentation":"

The `Function` object.

" } } }, "CreateGraphqlApiRequest":{ "type":"structure", "required":[ "name", "authenticationType" ], "members":{ "name":{ "shape":"String", "documentation":"

A user-supplied name for the `GraphqlApi`.

" }, "logConfig":{ "shape":"LogConfig", "documentation":"

The Amazon CloudWatch Logs configuration.

" }, "authenticationType":{ "shape":"AuthenticationType", "documentation":"

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

" }, "userPoolConfig":{ "shape":"UserPoolConfig", "documentation":"

The Amazon Cognito user pool configuration.

" }, "openIDConnectConfig":{ "shape":"OpenIDConnectConfig", "documentation":"

The OIDC configuration.

" }, "tags":{ "shape":"TagMap", "documentation":"

A `TagMap` object.

" }, "additionalAuthenticationProviders":{ "shape":"AdditionalAuthenticationProviders", "documentation":"

A list of additional authentication providers for the `GraphqlApi` API.

" }, "xrayEnabled":{ "shape":"Boolean", "documentation":"

A flag indicating whether to use X-Ray tracing for the `GraphqlApi`.

" }, "lambdaAuthorizerConfig":{ "shape":"LambdaAuthorizerConfig", "documentation":"

Configuration for Lambda function authorization.

" }, "visibility":{ "shape":"GraphQLApiVisibility", "documentation":"

Sets the value of the GraphQL API to public (`GLOBAL`) or private (`PRIVATE`). If no value is provided, the visibility will be set to `GLOBAL` by default. This value cannot be changed once the API has been created.

" }, "apiType":{ "shape":"GraphQLApiType", "documentation":"

The value that indicates whether the GraphQL API is a standard API (`GRAPHQL`) or merged API (`MERGED`).

" }, "mergedApiExecutionRoleArn":{ "shape":"String", "documentation":"

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the `AUTO_MERGE` to update the merged API endpoint with the source API changes automatically.

" }, "ownerContact":{ "shape":"String", "documentation":"

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

" }, "introspectionConfig":{ "shape":"GraphQLApiIntrospectionConfig", "documentation":"

Sets the value of the GraphQL API to enable (`ENABLED`) or disable (`DISABLED`) introspection. If no value is provided, the introspection configuration will be set to `ENABLED` by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection.

" }, "queryDepthLimit":{ "shape":"QueryDepthLimit", "documentation":"

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is `0` (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between `1` and `75` nested levels. This field will produce a limit error if the operation falls out of bounds.

Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

" }, "resolverCountLimit":{ "shape":"ResolverCountLimit", "documentation":"

The maximum number of resolvers that can be invoked in a single request. The default value is `0` (or unspecified), which will set the limit to `10000`. When specified, the limit value can be between `1` and `10000`. This field will produce a limit error if the operation falls out of bounds.

" } } }, "CreateGraphqlApiResponse":{ "type":"structure", "members":{ "graphqlApi":{ "shape":"GraphqlApi", "documentation":"

The `GraphqlApi`.

" } } }, "CreateResolverRequest":{ "type":"structure", "required":[ "apiId", "typeName", "fieldName" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The ID for the GraphQL API for which the resolver is being created.

", "location":"uri", "locationName":"apiId" }, "typeName":{ "shape":"ResourceName", "documentation":"

The name of the `Type`.

", "location":"uri", "locationName":"typeName" }, "fieldName":{ "shape":"ResourceName", "documentation":"

The name of the field to attach the resolver to.

" }, "dataSourceName":{ "shape":"ResourceName", "documentation":"

The name of the data source for which the resolver is being created.

" }, "requestMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The mapping template to use for requests.

A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

" }, "responseMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The mapping template to use for responses from the data source.

" }, "kind":{ "shape":"ResolverKind", "documentation":"

The resolver type.

- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.

- PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of `Function` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

" }, "pipelineConfig":{ "shape":"PipelineConfig", "documentation":"

The `PipelineConfig`.

" }, "syncConfig":{ "shape":"SyncConfig", "documentation":"

The `SyncConfig` for a resolver attached to a versioned data source.

" }, "cachingConfig":{ "shape":"CachingConfig", "documentation":"

The caching configuration for the resolver.

" }, "maxBatchSize":{ "shape":"MaxBatchSize", "documentation":"

The maximum batching size for a resolver.

" }, "runtime":{"shape":"AppSyncRuntime"}, "code":{ "shape":"Code", "documentation":"

The `resolver` code that contains the request and response functions. When code is used, the `runtime` is required. The `runtime` value must be `APPSYNC_JS`.

" } } }, "CreateResolverResponse":{ "type":"structure", "members":{ "resolver":{ "shape":"Resolver", "documentation":"

The `Resolver` object.

" } } }, "CreateTypeRequest":{ "type":"structure", "required":[ "apiId", "definition", "format" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "definition":{ "shape":"String", "documentation":"

The type definition, in GraphQL Schema Definition Language (SDL) format.

For more information, see the GraphQL SDL documentation.

" }, "format":{ "shape":"TypeDefinitionFormat", "documentation":"

The type format: SDL or JSON.

" } } }, "CreateTypeResponse":{ "type":"structure", "members":{ "type":{ "shape":"Type", "documentation":"

The `Type` object.

" } } }, "DataSource":{ "type":"structure", "members":{ "dataSourceArn":{ "shape":"String", "documentation":"

The data source Amazon Resource Name (ARN).

" }, "name":{ "shape":"ResourceName", "documentation":"

The name of the data source.

" }, "description":{ "shape":"String", "documentation":"

The description of the data source.

" }, "type":{ "shape":"DataSourceType", "documentation":"

The type of the data source.

- AWS_LAMBDA: The data source is an Lambda function.

- AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.

- AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.

- AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.

- AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.

- NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.

- HTTP: The data source is an HTTP endpoint.

- RELATIONAL_DATABASE: The data source is a relational database.

" }, "serviceRoleArn":{ "shape":"String", "documentation":"

The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.

" }, "dynamodbConfig":{ "shape":"DynamodbDataSourceConfig", "documentation":"

DynamoDB settings.

" }, "lambdaConfig":{ "shape":"LambdaDataSourceConfig", "documentation":"

Lambda settings.

" }, "elasticsearchConfig":{ "shape":"ElasticsearchDataSourceConfig", "documentation":"

Amazon OpenSearch Service settings.

" }, "openSearchServiceConfig":{ "shape":"OpenSearchServiceDataSourceConfig", "documentation":"

Amazon OpenSearch Service settings.

" }, "httpConfig":{ "shape":"HttpDataSourceConfig", "documentation":"

HTTP endpoint settings.

" }, "relationalDatabaseConfig":{ "shape":"RelationalDatabaseDataSourceConfig", "documentation":"

Relational database settings.

" }, "eventBridgeConfig":{ "shape":"EventBridgeDataSourceConfig", "documentation":"

Amazon EventBridge settings.

" } }, "documentation":"

Describes a data source.

" }, "DataSourceIntrospectionModel":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the model. For example, this could be the name of a single table in a database.

" }, "fields":{ "shape":"DataSourceIntrospectionModelFields", "documentation":"

The `DataSourceIntrospectionModelField` object data.

" }, "primaryKey":{ "shape":"DataSourceIntrospectionModelIndex", "documentation":"

The primary key stored as a `DataSourceIntrospectionModelIndex` object.

" }, "indexes":{ "shape":"DataSourceIntrospectionModelIndexes", "documentation":"

The array of `DataSourceIntrospectionModelIndex` objects.

" }, "sdl":{ "shape":"String", "documentation":"

Contains the output of the SDL that was generated from the introspected types. This is controlled by the `includeModelsSDL` parameter of the `GetDataSourceIntrospection` operation.

" } }, "documentation":"

Contains the introspected data that was retrieved from the data source.

" }, "DataSourceIntrospectionModelField":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the field that was retrieved from the introspected data.

" }, "type":{ "shape":"DataSourceIntrospectionModelFieldType", "documentation":"

The `DataSourceIntrospectionModelFieldType` object data.

" }, "length":{ "shape":"Long", "documentation":"

The length value of the introspected field.

" } }, "documentation":"

Represents the fields that were retrieved from the introspected data.

" }, "DataSourceIntrospectionModelFieldType":{ "type":"structure", "members":{ "kind":{ "shape":"String", "documentation":"

Specifies the classification of data. For example, this could be set to values like `Scalar` or `NonNull` to indicate a fundamental property of the field.

Valid values include:

- `Scalar`: Indicates the value is a primitive type (scalar).

- `NonNull`: Indicates the field cannot be `null`.

- `List`: Indicates the field contains a list.

" }, "name":{ "shape":"String", "documentation":"

The name of the data type that represents the field. For example, `String` is a valid `name` value.

" }, "type":{ "shape":"DataSourceIntrospectionModelFieldType", "documentation":"

The `DataSourceIntrospectionModelFieldType` object data. The `type` is only present if `DataSourceIntrospectionModelFieldType.kind` is set to `NonNull` or `List`.

The `type` typically contains its own `kind` and `name` fields to represent the actual type data. For instance, `type` could contain a `kind` value of `Scalar` with a `name` value of `String`. The values `Scalar` and `String` will be collectively stored in the `values` field.

" }, "values":{ "shape":"DataSourceIntrospectionModelFieldTypeValues", "documentation":"

The values of the `type` field. This field represents the AppSync data type equivalent of the introspected field.

" } }, "documentation":"

Represents the type data for each field retrieved from the introspection.

" }, "DataSourceIntrospectionModelFieldTypeValues":{ "type":"list", "member":{"shape":"String"} }, "DataSourceIntrospectionModelFields":{ "type":"list", "member":{"shape":"DataSourceIntrospectionModelField"} }, "DataSourceIntrospectionModelIndex":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the index.

" }, "fields":{ "shape":"DataSourceIntrospectionModelIndexFields", "documentation":"

The fields of the index.

" } }, "documentation":"

The index that was retrieved from the introspected data.

" }, "DataSourceIntrospectionModelIndexFields":{ "type":"list", "member":{"shape":"String"} }, "DataSourceIntrospectionModelIndexes":{ "type":"list", "member":{"shape":"DataSourceIntrospectionModelIndex"} }, "DataSourceIntrospectionModels":{ "type":"list", "member":{"shape":"DataSourceIntrospectionModel"} }, "DataSourceIntrospectionResult":{ "type":"structure", "members":{ "models":{ "shape":"DataSourceIntrospectionModels", "documentation":"

The array of `DataSourceIntrospectionModel` objects.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

Determines the number of types to be returned in a single response before paginating. This value is typically taken from `nextToken` value from the previous response.

" } }, "documentation":"

Represents the output of a `DataSourceIntrospectionResult`. This is the populated result of a `GetDataSourceIntrospection` operation.

" }, "DataSourceIntrospectionStatus":{ "type":"string", "enum":[ "PROCESSING", "FAILED", "SUCCESS" ] }, "DataSourceType":{ "type":"string", "enum":[ "AWS_LAMBDA", "AMAZON_DYNAMODB", "AMAZON_ELASTICSEARCH", "NONE", "HTTP", "RELATIONAL_DATABASE", "AMAZON_OPENSEARCH_SERVICE", "AMAZON_EVENTBRIDGE" ] }, "DataSources":{ "type":"list", "member":{"shape":"DataSource"} }, "Date":{"type":"timestamp"}, "DefaultAction":{ "type":"string", "enum":[ "ALLOW", "DENY" ] }, "DeleteApiCacheRequest":{ "type":"structure", "required":["apiId"], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" } }, "documentation":"

Represents the input of a `DeleteApiCache` operation.

" }, "DeleteApiCacheResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the output of a `DeleteApiCache` operation.

" }, "DeleteApiKeyRequest":{ "type":"structure", "required":[ "apiId", "id" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "id":{ "shape":"String", "documentation":"

The ID for the API key.

", "location":"uri", "locationName":"id" } } }, "DeleteApiKeyResponse":{ "type":"structure", "members":{ } }, "DeleteDataSourceRequest":{ "type":"structure", "required":[ "apiId", "name" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "name":{ "shape":"ResourceName", "documentation":"

The name of the data source.

", "location":"uri", "locationName":"name" } } }, "DeleteDataSourceResponse":{ "type":"structure", "members":{ } }, "DeleteDomainNameRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name.

", "location":"uri", "locationName":"domainName" } } }, "DeleteDomainNameResponse":{ "type":"structure", "members":{ } }, "DeleteFunctionRequest":{ "type":"structure", "required":[ "apiId", "functionId" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The GraphQL API ID.

", "location":"uri", "locationName":"apiId" }, "functionId":{ "shape":"ResourceName", "documentation":"

The `Function` ID.

", "location":"uri", "locationName":"functionId" } } }, "DeleteFunctionResponse":{ "type":"structure", "members":{ } }, "DeleteGraphqlApiRequest":{ "type":"structure", "required":["apiId"], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" } } }, "DeleteGraphqlApiResponse":{ "type":"structure", "members":{ } }, "DeleteResolverRequest":{ "type":"structure", "required":[ "apiId", "typeName", "fieldName" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "typeName":{ "shape":"ResourceName", "documentation":"

The name of the resolver type.

", "location":"uri", "locationName":"typeName" }, "fieldName":{ "shape":"ResourceName", "documentation":"

The resolver field name.

", "location":"uri", "locationName":"fieldName" } } }, "DeleteResolverResponse":{ "type":"structure", "members":{ } }, "DeleteTypeRequest":{ "type":"structure", "required":[ "apiId", "typeName" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "typeName":{ "shape":"ResourceName", "documentation":"

The type name.

", "location":"uri", "locationName":"typeName" } } }, "DeleteTypeResponse":{ "type":"structure", "members":{ } }, "DeltaSyncConfig":{ "type":"structure", "members":{ "baseTableTTL":{ "shape":"Long", "documentation":"

The number of minutes that an Item is stored in the data source.

" }, "deltaSyncTableName":{ "shape":"String", "documentation":"

The Delta Sync table name.

" }, "deltaSyncTableTTL":{ "shape":"Long", "documentation":"

The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.

" } }, "documentation":"

Describes a Delta Sync configuration.

" }, "Description":{ "type":"string", "max":255, "min":0, "pattern":"^.*$" }, "DisassociateApiRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name.

", "location":"uri", "locationName":"domainName" } } }, "DisassociateApiResponse":{ "type":"structure", "members":{ } }, "DisassociateMergedGraphqlApiRequest":{ "type":"structure", "required":[ "sourceApiIdentifier", "associationId" ], "members":{ "sourceApiIdentifier":{ "shape":"String", "documentation":"

The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.

", "location":"uri", "locationName":"sourceApiIdentifier" }, "associationId":{ "shape":"String", "documentation":"

The ID generated by the AppSync service for the source API association.

", "location":"uri", "locationName":"associationId" } } }, "DisassociateMergedGraphqlApiResponse":{ "type":"structure", "members":{ "sourceApiAssociationStatus":{ "shape":"SourceApiAssociationStatus", "documentation":"

The state of the source API association.

" } } }, "DisassociateSourceGraphqlApiRequest":{ "type":"structure", "required":[ "mergedApiIdentifier", "associationId" ], "members":{ "mergedApiIdentifier":{ "shape":"String", "documentation":"

The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

", "location":"uri", "locationName":"mergedApiIdentifier" }, "associationId":{ "shape":"String", "documentation":"

The ID generated by the AppSync service for the source API association.

", "location":"uri", "locationName":"associationId" } } }, "DisassociateSourceGraphqlApiResponse":{ "type":"structure", "members":{ "sourceApiAssociationStatus":{ "shape":"SourceApiAssociationStatus", "documentation":"

The state of the source API association.

" } } }, "DomainName":{ "type":"string", "max":253, "min":1, "pattern":"^(\\*[\\w\\d-]*\\.)?([\\w\\d-]+\\.)+[\\w\\d-]+$" }, "DomainNameConfig":{ "type":"structure", "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name.

" }, "description":{ "shape":"Description", "documentation":"

A description of the `DomainName` configuration.

" }, "certificateArn":{ "shape":"CertificateArn", "documentation":"

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.

" }, "appsyncDomainName":{ "shape":"String", "documentation":"

The domain name that AppSync provides.

" }, "hostedZoneId":{ "shape":"String", "documentation":"

The ID of your Amazon Route 53 hosted zone.

" } }, "documentation":"

Describes a configuration for a custom domain.

" }, "DomainNameConfigs":{ "type":"list", "member":{"shape":"DomainNameConfig"} }, "DynamodbDataSourceConfig":{ "type":"structure", "required":[ "tableName", "awsRegion" ], "members":{ "tableName":{ "shape":"String", "documentation":"

The table name.

" }, "awsRegion":{ "shape":"String", "documentation":"

The Amazon Web Services Region.

" }, "useCallerCredentials":{ "shape":"Boolean", "documentation":"

Set to TRUE to use Amazon Cognito credentials with this data source.

" }, "deltaSyncConfig":{ "shape":"DeltaSyncConfig", "documentation":"

The `DeltaSyncConfig` for a versioned data source.

" }, "versioned":{ "shape":"Boolean", "documentation":"

Set to TRUE to use Conflict Detection and Resolution with this data source.

" } }, "documentation":"

Describes an Amazon DynamoDB data source configuration.

" }, "ElasticsearchDataSourceConfig":{ "type":"structure", "required":[ "endpoint", "awsRegion" ], "members":{ "endpoint":{ "shape":"String", "documentation":"

The endpoint.

" }, "awsRegion":{ "shape":"String", "documentation":"

The Amazon Web Services Region.

" } }, "documentation":"

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.

" }, "ErrorDetail":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The error payload.

" } }, "documentation":"

Contains the list of errors generated. When using JavaScript, this will apply to the request or response function evaluation.

" }, "ErrorMessage":{"type":"string"}, "EvaluateCodeErrorDetail":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The error payload.

" }, "codeErrors":{ "shape":"CodeErrors", "documentation":"

Contains the list of `CodeError` objects.

" } }, "documentation":"

Contains the list of errors from a code evaluation response.

" }, "EvaluateCodeRequest":{ "type":"structure", "required":[ "runtime", "code", "context" ], "members":{ "runtime":{ "shape":"AppSyncRuntime", "documentation":"

The runtime to be used when evaluating the code. Currently, only the `APPSYNC_JS` runtime is supported.

" }, "code":{ "shape":"Code", "documentation":"

The code definition to be evaluated. Note that `code` and `runtime` are both required for this action. The `runtime` value must be `APPSYNC_JS`.

" }, "context":{ "shape":"Context", "documentation":"

The map that holds all of the contextual information for your resolver invocation. A `context` is required for this action.

" }, "function":{ "shape":"String", "documentation":"

The function within the code to be evaluated. If provided, the valid values are `request` and `response`.

" } } }, "EvaluateCodeResponse":{ "type":"structure", "members":{ "evaluationResult":{ "shape":"EvaluationResult", "documentation":"

The result of the evaluation operation.

" }, "error":{ "shape":"EvaluateCodeErrorDetail", "documentation":"

Contains the payload of the response error.

" }, "logs":{ "shape":"Logs", "documentation":"

A list of logs that were generated by calls to `util.log.info` and `util.log.error` in the evaluated code.

" } } }, "EvaluateMappingTemplateRequest":{ "type":"structure", "required":[ "template", "context" ], "members":{ "template":{ "shape":"Template", "documentation":"

The mapping template; this can be a request or response template. A `template` is required for this action.

" }, "context":{ "shape":"Context", "documentation":"

The map that holds all of the contextual information for your resolver invocation. A `context` is required for this action.

" } } }, "EvaluateMappingTemplateResponse":{ "type":"structure", "members":{ "evaluationResult":{ "shape":"EvaluationResult", "documentation":"

The mapping template; this can be a request or response template.

" }, "error":{ "shape":"ErrorDetail", "documentation":"

The `ErrorDetail` object.

" }, "logs":{ "shape":"Logs", "documentation":"

A list of logs that were generated by calls to `util.log.info` and `util.log.error` in the evaluated code.

" } } }, "EvaluationResult":{ "type":"string", "max":65536, "min":0, "pattern":"^[\\s\\S]*$" }, "EventBridgeDataSourceConfig":{ "type":"structure", "required":["eventBusArn"], "members":{ "eventBusArn":{ "shape":"String", "documentation":"

The ARN of the event bus. For more information about event buses, see Amazon EventBridge event buses.

" } }, "documentation":"

Describes an Amazon EventBridge bus data source configuration.

" }, "FieldLogLevel":{ "type":"string", "enum":[ "NONE", "ERROR", "ALL" ] }, "FlushApiCacheRequest":{ "type":"structure", "required":["apiId"], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" } }, "documentation":"

Represents the input of a `FlushApiCache` operation.

" }, "FlushApiCacheResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the output of a `FlushApiCache` operation.

" }, "FunctionConfiguration":{ "type":"structure", "members":{ "functionId":{ "shape":"String", "documentation":"

A unique ID representing the `Function` object.

" }, "functionArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the `Function` object.

" }, "name":{ "shape":"ResourceName", "documentation":"

The name of the `Function` object.

" }, "description":{ "shape":"String", "documentation":"

The `Function` description.

" }, "dataSourceName":{ "shape":"ResourceName", "documentation":"

The name of the `DataSource`.

" }, "requestMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The `Function` request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

" }, "responseMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The `Function` response mapping template.

" }, "functionVersion":{ "shape":"String", "documentation":"

The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.

" }, "syncConfig":{"shape":"SyncConfig"}, "maxBatchSize":{ "shape":"MaxBatchSize", "documentation":"

The maximum batching size for a resolver.

" }, "runtime":{"shape":"AppSyncRuntime"}, "code":{ "shape":"Code", "documentation":"

The `function` code that contains the request and response functions. When code is used, the `runtime` is required. The `runtime` value must be `APPSYNC_JS`.

" } }, "documentation":"

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

" }, "Functions":{ "type":"list", "member":{"shape":"FunctionConfiguration"} }, "FunctionsIds":{ "type":"list", "member":{"shape":"String"} }, "GetApiAssociationRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name.

", "location":"uri", "locationName":"domainName" } } }, "GetApiAssociationResponse":{ "type":"structure", "members":{ "apiAssociation":{ "shape":"ApiAssociation", "documentation":"

The `ApiAssociation` object.

" } } }, "GetApiCacheRequest":{ "type":"structure", "required":["apiId"], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" } }, "documentation":"

Represents the input of a `GetApiCache` operation.

" }, "GetApiCacheResponse":{ "type":"structure", "members":{ "apiCache":{ "shape":"ApiCache", "documentation":"

The `ApiCache` object.

" } }, "documentation":"

Represents the output of a `GetApiCache` operation.

" }, "GetDataSourceIntrospectionRequest":{ "type":"structure", "required":["introspectionId"], "members":{ "introspectionId":{ "shape":"String", "documentation":"

The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

", "location":"uri", "locationName":"introspectionId" }, "includeModelsSDL":{ "shape":"Boolean", "documentation":"

A boolean flag that determines whether SDL should be generated for introspected types or not. If set to `true`, each model will contain an `sdl` property that contains the SDL for that type. The SDL only contains the type data and no additional metadata or directives.

", "location":"querystring", "locationName":"includeModelsSDL" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

Determines the number of types to be returned in a single response before paginating. This value is typically taken from `nextToken` value from the previous response.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of introspected types that will be returned in a single response.

", "location":"querystring", "locationName":"maxResults" } } }, "GetDataSourceIntrospectionResponse":{ "type":"structure", "members":{ "introspectionId":{ "shape":"String", "documentation":"

The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

" }, "introspectionStatus":{ "shape":"DataSourceIntrospectionStatus", "documentation":"

The status of the introspection during retrieval. By default, when a new instrospection is being retrieved, the status will be set to `PROCESSING`. Once the operation has been completed, the status will change to `SUCCESS` or `FAILED` depending on how the data was parsed. A `FAILED` operation will return an error and its details as an `introspectionStatusDetail`.

" }, "introspectionStatusDetail":{ "shape":"String", "documentation":"

The error detail field. When a `FAILED` `introspectionStatus` is returned, the `introspectionStatusDetail` will also return the exact error that was generated during the operation.

" }, "introspectionResult":{ "shape":"DataSourceIntrospectionResult", "documentation":"

The `DataSourceIntrospectionResult` object data.

" } } }, "GetDataSourceRequest":{ "type":"structure", "required":[ "apiId", "name" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "name":{ "shape":"ResourceName", "documentation":"

The name of the data source.

", "location":"uri", "locationName":"name" } } }, "GetDataSourceResponse":{ "type":"structure", "members":{ "dataSource":{ "shape":"DataSource", "documentation":"

The `DataSource` object.

" } } }, "GetDomainNameRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name.

", "location":"uri", "locationName":"domainName" } } }, "GetDomainNameResponse":{ "type":"structure", "members":{ "domainNameConfig":{ "shape":"DomainNameConfig", "documentation":"

The configuration for the `DomainName`.

" } } }, "GetFunctionRequest":{ "type":"structure", "required":[ "apiId", "functionId" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The GraphQL API ID.

", "location":"uri", "locationName":"apiId" }, "functionId":{ "shape":"ResourceName", "documentation":"

The `Function` ID.

", "location":"uri", "locationName":"functionId" } } }, "GetFunctionResponse":{ "type":"structure", "members":{ "functionConfiguration":{ "shape":"FunctionConfiguration", "documentation":"

The `Function` object.

" } } }, "GetGraphqlApiRequest":{ "type":"structure", "required":["apiId"], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID for the GraphQL API.

", "location":"uri", "locationName":"apiId" } } }, "GetGraphqlApiResponse":{ "type":"structure", "members":{ "graphqlApi":{ "shape":"GraphqlApi", "documentation":"

The `GraphqlApi` object.

" } } }, "GetIntrospectionSchemaRequest":{ "type":"structure", "required":[ "apiId", "format" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "format":{ "shape":"OutputType", "documentation":"

The schema format: SDL or JSON.

", "location":"querystring", "locationName":"format" }, "includeDirectives":{ "shape":"BooleanValue", "documentation":"

A flag that specifies whether the schema introspection should contain directives.

", "location":"querystring", "locationName":"includeDirectives" } } }, "GetIntrospectionSchemaResponse":{ "type":"structure", "members":{ "schema":{ "shape":"Blob", "documentation":"

The schema, in GraphQL Schema Definition Language (SDL) format.

For more information, see the GraphQL SDL documentation.

" } }, "payload":"schema" }, "GetResolverRequest":{ "type":"structure", "required":[ "apiId", "typeName", "fieldName" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "typeName":{ "shape":"ResourceName", "documentation":"

The resolver type name.

", "location":"uri", "locationName":"typeName" }, "fieldName":{ "shape":"ResourceName", "documentation":"

The resolver field name.

", "location":"uri", "locationName":"fieldName" } } }, "GetResolverResponse":{ "type":"structure", "members":{ "resolver":{ "shape":"Resolver", "documentation":"

The `Resolver` object.

" } } }, "GetSchemaCreationStatusRequest":{ "type":"structure", "required":["apiId"], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" } } }, "GetSchemaCreationStatusResponse":{ "type":"structure", "members":{ "status":{ "shape":"SchemaStatus", "documentation":"

The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

" }, "details":{ "shape":"String", "documentation":"

Detailed information about the status of the schema creation operation.

" } } }, "GetSourceApiAssociationRequest":{ "type":"structure", "required":[ "mergedApiIdentifier", "associationId" ], "members":{ "mergedApiIdentifier":{ "shape":"String", "documentation":"

The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

", "location":"uri", "locationName":"mergedApiIdentifier" }, "associationId":{ "shape":"String", "documentation":"

The ID generated by the AppSync service for the source API association.

", "location":"uri", "locationName":"associationId" } } }, "GetSourceApiAssociationResponse":{ "type":"structure", "members":{ "sourceApiAssociation":{ "shape":"SourceApiAssociation", "documentation":"

The `SourceApiAssociation` object data.

" } } }, "GetTypeRequest":{ "type":"structure", "required":[ "apiId", "typeName", "format" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "typeName":{ "shape":"ResourceName", "documentation":"

The type name.

", "location":"uri", "locationName":"typeName" }, "format":{ "shape":"TypeDefinitionFormat", "documentation":"

The type format: SDL or JSON.

", "location":"querystring", "locationName":"format" } } }, "GetTypeResponse":{ "type":"structure", "members":{ "type":{ "shape":"Type", "documentation":"

The `Type` object.

" } } }, "GraphQLApiIntrospectionConfig":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "GraphQLApiType":{ "type":"string", "enum":[ "GRAPHQL", "MERGED" ] }, "GraphQLApiVisibility":{ "type":"string", "enum":[ "GLOBAL", "PRIVATE" ] }, "GraphQLSchemaException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The GraphQL schema is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "GraphqlApi":{ "type":"structure", "members":{ "name":{ "shape":"ResourceName", "documentation":"

The API name.

" }, "apiId":{ "shape":"String", "documentation":"

The API ID.

" }, "authenticationType":{ "shape":"AuthenticationType", "documentation":"

The authentication type.

" }, "logConfig":{ "shape":"LogConfig", "documentation":"

The Amazon CloudWatch Logs configuration.

" }, "userPoolConfig":{ "shape":"UserPoolConfig", "documentation":"

The Amazon Cognito user pool configuration.

" }, "openIDConnectConfig":{ "shape":"OpenIDConnectConfig", "documentation":"

The OpenID Connect configuration.

" }, "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN).

" }, "uris":{ "shape":"MapOfStringToString", "documentation":"

The URIs.

" }, "tags":{ "shape":"TagMap", "documentation":"

The tags.

" }, "additionalAuthenticationProviders":{ "shape":"AdditionalAuthenticationProviders", "documentation":"

A list of additional authentication providers for the `GraphqlApi` API.

" }, "xrayEnabled":{ "shape":"Boolean", "documentation":"

A flag indicating whether to use X-Ray tracing for this `GraphqlApi`.

" }, "wafWebAclArn":{ "shape":"String", "documentation":"

The ARN of the WAF access control list (ACL) associated with this `GraphqlApi`, if one exists.

" }, "lambdaAuthorizerConfig":{ "shape":"LambdaAuthorizerConfig", "documentation":"

Configuration for Lambda function authorization.

" }, "dns":{ "shape":"MapOfStringToString", "documentation":"

The DNS records for the API.

" }, "visibility":{ "shape":"GraphQLApiVisibility", "documentation":"

Sets the value of the GraphQL API to public (`GLOBAL`) or private (`PRIVATE`). If no value is provided, the visibility will be set to `GLOBAL` by default. This value cannot be changed once the API has been created.

" }, "apiType":{ "shape":"GraphQLApiType", "documentation":"

The value that indicates whether the GraphQL API is a standard API (`GRAPHQL`) or merged API (`MERGED`).

" }, "mergedApiExecutionRoleArn":{ "shape":"String", "documentation":"

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the `AUTO_MERGE` to update the merged API endpoint with the source API changes automatically.

" }, "owner":{ "shape":"String", "documentation":"

The account owner of the GraphQL API.

" }, "ownerContact":{ "shape":"String", "documentation":"

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

" }, "introspectionConfig":{ "shape":"GraphQLApiIntrospectionConfig", "documentation":"

Sets the value of the GraphQL API to enable (`ENABLED`) or disable (`DISABLED`) introspection. If no value is provided, the introspection configuration will be set to `ENABLED` by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection.

" }, "queryDepthLimit":{ "shape":"QueryDepthLimit", "documentation":"

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is `0` (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between `1` and `75` nested levels. This field will produce a limit error if the operation falls out of bounds.

Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

" }, "resolverCountLimit":{ "shape":"ResolverCountLimit", "documentation":"

The maximum number of resolvers that can be invoked in a single request. The default value is `0` (or unspecified), which will set the limit to `10000`. When specified, the limit value can be between `1` and `10000`. This field will produce a limit error if the operation falls out of bounds.

" } }, "documentation":"

Describes a GraphQL API.

" }, "GraphqlApis":{ "type":"list", "member":{"shape":"GraphqlApi"} }, "HttpDataSourceConfig":{ "type":"structure", "members":{ "endpoint":{ "shape":"String", "documentation":"

The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.

" }, "authorizationConfig":{ "shape":"AuthorizationConfig", "documentation":"

The authorization configuration in case the HTTP endpoint requires authorization.

" } }, "documentation":"

Describes an HTTP data source configuration.

" }, "InternalFailureException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

An internal AppSync error occurred. Try your request again.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "LambdaAuthorizerConfig":{ "type":"structure", "required":["authorizerUri"], "members":{ "authorizerResultTtlInSeconds":{ "shape":"TTL", "documentation":"

The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for `authorizerResultTtlInSeconds`, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a `ttlOverride` key in its response.

" }, "authorizerUri":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (`.../v3`), or an alias ARN.

Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:

`aws lambda add-permission --function-name \"arn:aws:lambda:us-east-2:111122223333:function:my-function\" --statement-id \"appsync\" --principal appsync.amazonaws.com --action lambda:InvokeFunction`

" }, "identityValidationExpression":{ "shape":"String", "documentation":"

A regular expression for validation of tokens before the Lambda function is called.

" } }, "documentation":"

A `LambdaAuthorizerConfig` specifies how to authorize AppSync API access when using the `AWS_LAMBDA` authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a time.

" }, "LambdaConflictHandlerConfig":{ "type":"structure", "members":{ "lambdaConflictHandlerArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.

" } }, "documentation":"

The `LambdaConflictHandlerConfig` object when configuring `LAMBDA` as the Conflict Handler.

" }, "LambdaDataSourceConfig":{ "type":"structure", "required":["lambdaFunctionArn"], "members":{ "lambdaFunctionArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the Lambda function.

" } }, "documentation":"

Describes an Lambda data source configuration.

" }, "LimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The request exceeded a limit. Try your request again.

", "error":{"httpStatusCode":429}, "exception":true }, "ListApiKeysRequest":{ "type":"structure", "required":["apiId"], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that you want the request to return.

", "location":"querystring", "locationName":"maxResults" } } }, "ListApiKeysResponse":{ "type":"structure", "members":{ "apiKeys":{ "shape":"ApiKeys", "documentation":"

The `ApiKey` objects.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier to pass in the next request to this operation to return the next set of items in the list.

" } } }, "ListDataSourcesRequest":{ "type":"structure", "required":["apiId"], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that you want the request to return.

", "location":"querystring", "locationName":"maxResults" } } }, "ListDataSourcesResponse":{ "type":"structure", "members":{ "dataSources":{ "shape":"DataSources", "documentation":"

The `DataSource` objects.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier to pass in the next request to this operation to return the next set of items in the list.

" } } }, "ListDomainNamesRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that you want the request to return.

", "location":"querystring", "locationName":"maxResults" } } }, "ListDomainNamesResponse":{ "type":"structure", "members":{ "domainNameConfigs":{ "shape":"DomainNameConfigs", "documentation":"

Lists configurations for multiple domain names.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

" } } }, "ListFunctionsRequest":{ "type":"structure", "required":["apiId"], "members":{ "apiId":{ "shape":"String", "documentation":"

The GraphQL API ID.

", "location":"uri", "locationName":"apiId" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that you want the request to return.

", "location":"querystring", "locationName":"maxResults" } } }, "ListFunctionsResponse":{ "type":"structure", "members":{ "functions":{ "shape":"Functions", "documentation":"

A list of `Function` objects.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

" } } }, "ListGraphqlApisRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that you want the request to return.

", "location":"querystring", "locationName":"maxResults" }, "apiType":{ "shape":"GraphQLApiType", "documentation":"

The value that indicates whether the GraphQL API is a standard API (`GRAPHQL`) or merged API (`MERGED`).

", "location":"querystring", "locationName":"apiType" }, "owner":{ "shape":"Ownership", "documentation":"

The account owner of the GraphQL API.

", "location":"querystring", "locationName":"owner" } } }, "ListGraphqlApisResponse":{ "type":"structure", "members":{ "graphqlApis":{ "shape":"GraphqlApis", "documentation":"

The `GraphqlApi` objects.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier to pass in the next request to this operation to return the next set of items in the list.

" } } }, "ListResolversByFunctionRequest":{ "type":"structure", "required":[ "apiId", "functionId" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "functionId":{ "shape":"String", "documentation":"

The function ID.

", "location":"uri", "locationName":"functionId" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that you want the request to return.

", "location":"querystring", "locationName":"maxResults" } } }, "ListResolversByFunctionResponse":{ "type":"structure", "members":{ "resolvers":{ "shape":"Resolvers", "documentation":"

The list of resolvers.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that you can use to return the next set of items in the list.

" } } }, "ListResolversRequest":{ "type":"structure", "required":[ "apiId", "typeName" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "typeName":{ "shape":"String", "documentation":"

The type name.

", "location":"uri", "locationName":"typeName" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that you want the request to return.

", "location":"querystring", "locationName":"maxResults" } } }, "ListResolversResponse":{ "type":"structure", "members":{ "resolvers":{ "shape":"Resolvers", "documentation":"

The `Resolver` objects.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier to pass in the next request to this operation to return the next set of items in the list.

" } } }, "ListSourceApiAssociationsRequest":{ "type":"structure", "required":["apiId"], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that you want the request to return.

", "location":"querystring", "locationName":"maxResults" } } }, "ListSourceApiAssociationsResponse":{ "type":"structure", "members":{ "sourceApiAssociationSummaries":{ "shape":"SourceApiAssociationSummaryList", "documentation":"

The `SourceApiAssociationSummary` object data.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

The `GraphqlApi` Amazon Resource Name (ARN).

", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", "documentation":"

A `TagMap` object.

" } } }, "ListTypesByAssociationRequest":{ "type":"structure", "required":[ "mergedApiIdentifier", "associationId", "format" ], "members":{ "mergedApiIdentifier":{ "shape":"String", "documentation":"

The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

", "location":"uri", "locationName":"mergedApiIdentifier" }, "associationId":{ "shape":"String", "documentation":"

The ID generated by the AppSync service for the source API association.

", "location":"uri", "locationName":"associationId" }, "format":{ "shape":"TypeDefinitionFormat", "documentation":"

The format type.

", "location":"querystring", "locationName":"format" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that you want the request to return.

", "location":"querystring", "locationName":"maxResults" } } }, "ListTypesByAssociationResponse":{ "type":"structure", "members":{ "types":{ "shape":"TypeList", "documentation":"

The `Type` objects.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

" } } }, "ListTypesRequest":{ "type":"structure", "required":[ "apiId", "format" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "format":{ "shape":"TypeDefinitionFormat", "documentation":"

The type format: SDL or JSON.

", "location":"querystring", "locationName":"format" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results that you want the request to return.

", "location":"querystring", "locationName":"maxResults" } } }, "ListTypesResponse":{ "type":"structure", "members":{ "types":{ "shape":"TypeList", "documentation":"

The `Type` objects.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier to pass in the next request to this operation to return the next set of items in the list.

" } } }, "LogConfig":{ "type":"structure", "required":[ "fieldLogLevel", "cloudWatchLogsRoleArn" ], "members":{ "fieldLogLevel":{ "shape":"FieldLogLevel", "documentation":"

The field logging level. Values can be NONE, ERROR, or ALL.

- NONE: No field-level logs are captured.

- ERROR: Logs the following information only for the fields that are in error:

  - The error section in the server response.

  - Field-level errors.

  - The generated request/response functions that got resolved for error fields.

- ALL: The following information is logged for all fields in the query:

  - Field-level tracing information.

  - The generated request/response functions that got resolved for each field.

" }, "cloudWatchLogsRoleArn":{ "shape":"String", "documentation":"

The service role that AppSync assumes to publish to CloudWatch logs in your account.

" }, "excludeVerboseContent":{ "shape":"Boolean", "documentation":"

Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

" } }, "documentation":"

The Amazon CloudWatch Logs configuration.

" }, "Logs":{ "type":"list", "member":{"shape":"String"} }, "Long":{"type":"long"}, "MapOfStringToString":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "MappingTemplate":{ "type":"string", "max":65536, "min":1, "pattern":"^.*$" }, "MaxBatchSize":{ "type":"integer", "max":2000, "min":0 }, "MaxResults":{ "type":"integer", "max":25, "min":0 }, "MergeType":{ "type":"string", "enum":[ "MANUAL_MERGE", "AUTO_MERGE" ] }, "NotFoundException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The resource specified in the request was not found. Check the resource, and then try again.

", "error":{"httpStatusCode":404}, "exception":true }, "OpenIDConnectConfig":{ "type":"structure", "required":["issuer"], "members":{ "issuer":{ "shape":"String", "documentation":"

The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of `iss` in the ID token.

" }, "clientId":{ "shape":"String", "documentation":"

The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

" }, "iatTTL":{ "shape":"Long", "documentation":"

The number of milliseconds that a token is valid after it's issued to a user.

" }, "authTTL":{ "shape":"Long", "documentation":"

The number of milliseconds that a token is valid after being authenticated.

" } }, "documentation":"

Describes an OpenID Connect (OIDC) configuration.

" }, "OpenSearchServiceDataSourceConfig":{ "type":"structure", "required":[ "endpoint", "awsRegion" ], "members":{ "endpoint":{ "shape":"String", "documentation":"

The endpoint.

" }, "awsRegion":{ "shape":"String", "documentation":"

The Amazon Web Services Region.

" } }, "documentation":"

Describes an OpenSearch data source configuration.

" }, "OutputType":{ "type":"string", "enum":[ "SDL", "JSON" ] }, "Ownership":{ "type":"string", "enum":[ "CURRENT_ACCOUNT", "OTHER_ACCOUNTS" ] }, "PaginationToken":{ "type":"string", "max":65536, "min":1, "pattern":"[\\\\S]+" }, "PipelineConfig":{ "type":"structure", "members":{ "functions":{ "shape":"FunctionsIds", "documentation":"

A list of `Function` objects.

" } }, "documentation":"

The pipeline configuration for a resolver of kind `PIPELINE`.

" }, "QueryDepthLimit":{ "type":"integer", "max":75, "min":0 }, "RdsDataApiConfig":{ "type":"structure", "required":[ "resourceArn", "secretArn", "databaseName" ], "members":{ "resourceArn":{ "shape":"RdsDataApiConfigResourceArn", "documentation":"

The resource ARN of the RDS cluster.

" }, "secretArn":{ "shape":"RdsDataApiConfigSecretArn", "documentation":"

The secret's ARN that was obtained from Secrets Manager. A secret consists of secret information, the secret value, plus metadata about the secret. A secret value can be a string or binary. It typically includes the ARN, secret name and description, policies, tags, encryption key from the Key Management Service, and key rotation data.

" }, "databaseName":{ "shape":"RdsDataApiConfigDatabaseName", "documentation":"

The name of the database in the cluster.

" } }, "documentation":"

Contains the metadata required to introspect the RDS cluster.

" }, "RdsDataApiConfigDatabaseName":{ "type":"string", "max":128, "min":1 }, "RdsDataApiConfigResourceArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:[a-z-]*:rds:[a-z0-9-]*:\\d{12}:cluster:[0-9A-Za-z_/-]*$" }, "RdsDataApiConfigSecretArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:[a-z-]*:secretsmanager:[a-z0-9-]*:\\d{12}:secret:[0-9A-Za-z_/-]*$" }, "RdsHttpEndpointConfig":{ "type":"structure", "members":{ "awsRegion":{ "shape":"String", "documentation":"

Amazon Web Services Region for Amazon RDS HTTP endpoint.

" }, "dbClusterIdentifier":{ "shape":"String", "documentation":"

Amazon RDS cluster Amazon Resource Name (ARN).

" }, "databaseName":{ "shape":"String", "documentation":"

Logical database name.

" }, "schema":{ "shape":"String", "documentation":"

Logical schema name.

" }, "awsSecretStoreArn":{ "shape":"String", "documentation":"

Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.

" } }, "documentation":"

The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.

" }, "RelationalDatabaseDataSourceConfig":{ "type":"structure", "members":{ "relationalDatabaseSourceType":{ "shape":"RelationalDatabaseSourceType", "documentation":"

Source type for the relational database.

- RDS_HTTP_ENDPOINT: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.

" }, "rdsHttpEndpointConfig":{ "shape":"RdsHttpEndpointConfig", "documentation":"

Amazon RDS HTTP endpoint settings.

" } }, "documentation":"

Describes a relational database data source configuration.

" }, "RelationalDatabaseSourceType":{ "type":"string", "enum":["RDS_HTTP_ENDPOINT"] }, "Resolver":{ "type":"structure", "members":{ "typeName":{ "shape":"ResourceName", "documentation":"

The resolver type name.

" }, "fieldName":{ "shape":"ResourceName", "documentation":"

The resolver field name.

" }, "dataSourceName":{ "shape":"ResourceName", "documentation":"

The resolver data source name.

" }, "resolverArn":{ "shape":"String", "documentation":"

The resolver Amazon Resource Name (ARN).

" }, "requestMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The request mapping template.

" }, "responseMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The response mapping template.

" }, "kind":{ "shape":"ResolverKind", "documentation":"

The resolver type.

- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.

- PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of `Function` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

" }, "pipelineConfig":{ "shape":"PipelineConfig", "documentation":"

The `PipelineConfig`.

" }, "syncConfig":{ "shape":"SyncConfig", "documentation":"

The `SyncConfig` for a resolver attached to a versioned data source.

" }, "cachingConfig":{ "shape":"CachingConfig", "documentation":"

The caching configuration for the resolver.

" }, "maxBatchSize":{ "shape":"MaxBatchSize", "documentation":"

The maximum batching size for a resolver.

" }, "runtime":{"shape":"AppSyncRuntime"}, "code":{ "shape":"Code", "documentation":"

The `resolver` code that contains the request and response functions. When code is used, the `runtime` is required. The `runtime` value must be `APPSYNC_JS`.

" } }, "documentation":"

Describes a resolver.

" }, "ResolverCountLimit":{ "type":"integer", "max":10000, "min":0 }, "ResolverKind":{ "type":"string", "enum":[ "UNIT", "PIPELINE" ] }, "Resolvers":{ "type":"list", "member":{"shape":"Resolver"} }, "ResourceArn":{ "type":"string", "max":75, "min":70, "pattern":"^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\\d{12}:apis/[0-9A-Za-z_-]{26}$" }, "ResourceName":{ "type":"string", "max":65536, "min":1, "pattern":"[_A-Za-z][_0-9A-Za-z]*" }, "RuntimeName":{ "type":"string", "enum":["APPSYNC_JS"] }, "SchemaStatus":{ "type":"string", "enum":[ "PROCESSING", "ACTIVE", "DELETING", "FAILED", "SUCCESS", "NOT_APPLICABLE" ] }, "SourceApiAssociation":{ "type":"structure", "members":{ "associationId":{ "shape":"String", "documentation":"

The ID generated by the AppSync service for the source API association.

" }, "associationArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the source API association.

" }, "sourceApiId":{ "shape":"String", "documentation":"

The ID of the AppSync source API.

" }, "sourceApiArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the AppSync source API.

" }, "mergedApiArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the AppSync Merged API.

" }, "mergedApiId":{ "shape":"String", "documentation":"

The ID of the AppSync Merged API.

" }, "description":{ "shape":"String", "documentation":"

The description field.

" }, "sourceApiAssociationConfig":{ "shape":"SourceApiAssociationConfig", "documentation":"

The `SourceApiAssociationConfig` object data.

" }, "sourceApiAssociationStatus":{ "shape":"SourceApiAssociationStatus", "documentation":"

The state of the source API association.

" }, "sourceApiAssociationStatusDetail":{ "shape":"String", "documentation":"

The detailed message related to the current state of the source API association.

" }, "lastSuccessfulMergeDate":{ "shape":"Date", "documentation":"

The datetime value of the last successful merge of the source API association. The result will be in UTC format and your local time zone.

" } }, "documentation":"

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":{ "type":"structure", "members":{ "mergeType":{ "shape":"MergeType", "documentation":"

The property that indicates which merging option is enabled in the source API association.

Valid merge types are `MANUAL_MERGE` (default) and `AUTO_MERGE`. Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use `MergedApiExecutionRoleArn` to perform merge operations.

" } }, "documentation":"

Describes properties used to specify configurations related to a source API.

" }, "SourceApiAssociationStatus":{ "type":"string", "enum":[ "MERGE_SCHEDULED", "MERGE_FAILED", "MERGE_SUCCESS", "MERGE_IN_PROGRESS", "AUTO_MERGE_SCHEDULE_FAILED", "DELETION_SCHEDULED", "DELETION_IN_PROGRESS", "DELETION_FAILED" ] }, "SourceApiAssociationSummary":{ "type":"structure", "members":{ "associationId":{ "shape":"String", "documentation":"

The ID generated by the AppSync service for the source API association.

" }, "associationArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the source API association.

" }, "sourceApiId":{ "shape":"String", "documentation":"

The ID of the AppSync source API.

" }, "sourceApiArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the AppSync Source API.

" }, "mergedApiId":{ "shape":"String", "documentation":"

The ID of the AppSync Merged API.

" }, "mergedApiArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the AppSync Merged API.

" }, "description":{ "shape":"String", "documentation":"

The description field.

" } }, "documentation":"

Describes the ARNs and IDs of associations, Merged APIs, and source APIs.

" }, "SourceApiAssociationSummaryList":{ "type":"list", "member":{"shape":"SourceApiAssociationSummary"} }, "StartDataSourceIntrospectionRequest":{ "type":"structure", "members":{ "rdsDataApiConfig":{ "shape":"RdsDataApiConfig", "documentation":"

The `rdsDataApiConfig` object data.

" } } }, "StartDataSourceIntrospectionResponse":{ "type":"structure", "members":{ "introspectionId":{ "shape":"String", "documentation":"

The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

" }, "introspectionStatus":{ "shape":"DataSourceIntrospectionStatus", "documentation":"

The status of the introspection during creation. By default, when a new instrospection has been created, the status will be set to `PROCESSING`. Once the operation has been completed, the status will change to `SUCCESS` or `FAILED` depending on how the data was parsed. A `FAILED` operation will return an error and its details as an `introspectionStatusDetail`.

" }, "introspectionStatusDetail":{ "shape":"String", "documentation":"

The error detail field. When a `FAILED` `introspectionStatus` is returned, the `introspectionStatusDetail` will also return the exact error that was generated during the operation.

" } } }, "StartSchemaCreationRequest":{ "type":"structure", "required":[ "apiId", "definition" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "definition":{ "shape":"Blob", "documentation":"

The schema definition, in GraphQL schema language format.

" } } }, "StartSchemaCreationResponse":{ "type":"structure", "members":{ "status":{ "shape":"SchemaStatus", "documentation":"

The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

" } } }, "StartSchemaMergeRequest":{ "type":"structure", "required":[ "associationId", "mergedApiIdentifier" ], "members":{ "associationId":{ "shape":"String", "documentation":"

The ID generated by the AppSync service for the source API association.

", "location":"uri", "locationName":"associationId" }, "mergedApiIdentifier":{ "shape":"String", "documentation":"

The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

", "location":"uri", "locationName":"mergedApiIdentifier" } } }, "StartSchemaMergeResponse":{ "type":"structure", "members":{ "sourceApiAssociationStatus":{ "shape":"SourceApiAssociationStatus", "documentation":"

The state of the source API association.

" } } }, "String":{"type":"string"}, "SyncConfig":{ "type":"structure", "members":{ "conflictHandler":{ "shape":"ConflictHandlerType", "documentation":"

The Conflict Resolution strategy to perform in the event of a conflict.

- OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.

- AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.

- LAMBDA: Resolve conflicts with an Lambda function supplied in the `LambdaConflictHandlerConfig`.

" }, "conflictDetection":{ "shape":"ConflictDetectionType", "documentation":"

The Conflict Detection strategy to use.

- VERSION: Detect conflicts based on object versions for this resolver.

- NONE: Do not detect conflicts when invoking this resolver.

" }, "lambdaConflictHandlerConfig":{ "shape":"LambdaConflictHandlerConfig", "documentation":"

The `LambdaConflictHandlerConfig` when configuring `LAMBDA` as the Conflict Handler.

" } }, "documentation":"

Describes a Sync configuration for a resolver.

Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

" }, "TTL":{ "type":"integer", "max":3600, "min":0 }, "TagKey":{ "type":"string", "documentation":"

The key for the tag.

", "max":128, "min":1, "pattern":"^(?!aws:)[ a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "documentation":"

A map with keys of `TagKey` objects and values of `TagValue` objects.

", "max":50, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

The `GraphqlApi` Amazon Resource Name (ARN).

", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"

A `TagMap` object.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "documentation":"

The value for the tag.

", "max":256, "pattern":"^[\\s\\w+-=\\.:/@]*$" }, "Template":{ "type":"string", "max":65536, "min":2, "pattern":"^[\\s\\S]*$" }, "Type":{ "type":"structure", "members":{ "name":{ "shape":"ResourceName", "documentation":"

The type name.

" }, "description":{ "shape":"String", "documentation":"

The type description.

" }, "arn":{ "shape":"String", "documentation":"

The type Amazon Resource Name (ARN).

" }, "definition":{ "shape":"String", "documentation":"

The type definition.

" }, "format":{ "shape":"TypeDefinitionFormat", "documentation":"

The type format: SDL or JSON.

" } }, "documentation":"

Describes a type.

" }, "TypeDefinitionFormat":{ "type":"string", "enum":[ "SDL", "JSON" ] }, "TypeList":{ "type":"list", "member":{"shape":"Type"} }, "UnauthorizedException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

You aren't authorized to perform this operation.

", "error":{"httpStatusCode":401}, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

The `GraphqlApi` Amazon Resource Name (ARN).

", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

A list of `TagKey` objects.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateApiCacheRequest":{ "type":"structure", "required":[ "apiId", "ttl", "apiCachingBehavior", "type" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The GraphQL API ID.

", "location":"uri", "locationName":"apiId" }, "ttl":{ "shape":"Long", "documentation":"

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

" }, "apiCachingBehavior":{ "shape":"ApiCachingBehavior", "documentation":"

Caching behavior.

- FULL_REQUEST_CACHING: All requests are fully cached.

- PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

" }, "type":{ "shape":"ApiCacheType", "documentation":"

The cache instance type. Valid values are

- `SMALL`

- `MEDIUM`

- `LARGE`

- `XLARGE`

- `LARGE_2X`

- `LARGE_4X`

- `LARGE_8X` (not available in all regions)

- `LARGE_12X`

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

- T2_SMALL: A t2.small instance type.

- T2_MEDIUM: A t2.medium instance type.

- R4_LARGE: A r4.large instance type.

- R4_XLARGE: A r4.xlarge instance type.

- R4_2XLARGE: A r4.2xlarge instance type.

- R4_4XLARGE: A r4.4xlarge instance type.

- R4_8XLARGE: A r4.8xlarge instance type.

" } }, "documentation":"

Represents the input of a `UpdateApiCache` operation.

" }, "UpdateApiCacheResponse":{ "type":"structure", "members":{ "apiCache":{ "shape":"ApiCache", "documentation":"

The `ApiCache` object.

" } }, "documentation":"

Represents the output of a `UpdateApiCache` operation.

" }, "UpdateApiKeyRequest":{ "type":"structure", "required":[ "apiId", "id" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The ID for the GraphQL API.

", "location":"uri", "locationName":"apiId" }, "id":{ "shape":"String", "documentation":"

The API key ID.

", "location":"uri", "locationName":"id" }, "description":{ "shape":"String", "documentation":"

A description of the purpose of the API key.

" }, "expires":{ "shape":"Long", "documentation":"

From the update time, the time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .

" } } }, "UpdateApiKeyResponse":{ "type":"structure", "members":{ "apiKey":{ "shape":"ApiKey", "documentation":"

The API key.

" } } }, "UpdateDataSourceRequest":{ "type":"structure", "required":[ "apiId", "name", "type" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "name":{ "shape":"ResourceName", "documentation":"

The new name for the data source.

", "location":"uri", "locationName":"name" }, "description":{ "shape":"String", "documentation":"

The new description for the data source.

" }, "type":{ "shape":"DataSourceType", "documentation":"

The new data source type.

" }, "serviceRoleArn":{ "shape":"String", "documentation":"

The new service role Amazon Resource Name (ARN) for the data source.

" }, "dynamodbConfig":{ "shape":"DynamodbDataSourceConfig", "documentation":"

The new Amazon DynamoDB configuration.

" }, "lambdaConfig":{ "shape":"LambdaDataSourceConfig", "documentation":"

The new Lambda configuration.

" }, "elasticsearchConfig":{ "shape":"ElasticsearchDataSourceConfig", "documentation":"

The new OpenSearch configuration.

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.

" }, "openSearchServiceConfig":{ "shape":"OpenSearchServiceDataSourceConfig", "documentation":"

The new OpenSearch configuration.

" }, "httpConfig":{ "shape":"HttpDataSourceConfig", "documentation":"

The new HTTP endpoint configuration.

" }, "relationalDatabaseConfig":{ "shape":"RelationalDatabaseDataSourceConfig", "documentation":"

The new relational database configuration.

" }, "eventBridgeConfig":{ "shape":"EventBridgeDataSourceConfig", "documentation":"

The new Amazon EventBridge settings.

" } } }, "UpdateDataSourceResponse":{ "type":"structure", "members":{ "dataSource":{ "shape":"DataSource", "documentation":"

The updated `DataSource` object.

" } } }, "UpdateDomainNameRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name.

", "location":"uri", "locationName":"domainName" }, "description":{ "shape":"Description", "documentation":"

A description of the `DomainName`.

" } } }, "UpdateDomainNameResponse":{ "type":"structure", "members":{ "domainNameConfig":{ "shape":"DomainNameConfig", "documentation":"

The configuration for the `DomainName`.

" } } }, "UpdateFunctionRequest":{ "type":"structure", "required":[ "apiId", "name", "functionId", "dataSourceName" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The GraphQL API ID.

", "location":"uri", "locationName":"apiId" }, "name":{ "shape":"ResourceName", "documentation":"

The `Function` name.

" }, "description":{ "shape":"String", "documentation":"

The `Function` description.

" }, "functionId":{ "shape":"ResourceName", "documentation":"

The function ID.

", "location":"uri", "locationName":"functionId" }, "dataSourceName":{ "shape":"ResourceName", "documentation":"

The `Function` `DataSource` name.

" }, "requestMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The `Function` request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

" }, "responseMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The `Function` request mapping template.

" }, "functionVersion":{ "shape":"String", "documentation":"

The `version` of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the `functionVersion` is required.

" }, "syncConfig":{"shape":"SyncConfig"}, "maxBatchSize":{ "shape":"MaxBatchSize", "documentation":"

The maximum batching size for a resolver.

" }, "runtime":{"shape":"AppSyncRuntime"}, "code":{ "shape":"Code", "documentation":"

The `function` code that contains the request and response functions. When code is used, the `runtime` is required. The `runtime` value must be `APPSYNC_JS`.

" } } }, "UpdateFunctionResponse":{ "type":"structure", "members":{ "functionConfiguration":{ "shape":"FunctionConfiguration", "documentation":"

The `Function` object.

" } } }, "UpdateGraphqlApiRequest":{ "type":"structure", "required":[ "apiId", "name" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "name":{ "shape":"String", "documentation":"

The new name for the `GraphqlApi` object.

" }, "logConfig":{ "shape":"LogConfig", "documentation":"

The Amazon CloudWatch Logs configuration for the `GraphqlApi` object.

" }, "authenticationType":{ "shape":"AuthenticationType", "documentation":"

The new authentication type for the `GraphqlApi` object.

" }, "userPoolConfig":{ "shape":"UserPoolConfig", "documentation":"

The new Amazon Cognito user pool configuration for the `~GraphqlApi` object.

" }, "openIDConnectConfig":{ "shape":"OpenIDConnectConfig", "documentation":"

The OpenID Connect configuration for the `GraphqlApi` object.

" }, "additionalAuthenticationProviders":{ "shape":"AdditionalAuthenticationProviders", "documentation":"

A list of additional authentication providers for the `GraphqlApi` API.

" }, "xrayEnabled":{ "shape":"Boolean", "documentation":"

A flag indicating whether to use X-Ray tracing for the `GraphqlApi`.

" }, "lambdaAuthorizerConfig":{ "shape":"LambdaAuthorizerConfig", "documentation":"

Configuration for Lambda function authorization.

" }, "mergedApiExecutionRoleArn":{ "shape":"String", "documentation":"

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the `AUTO_MERGE` to update the merged API endpoint with the source API changes automatically.

" }, "ownerContact":{ "shape":"String", "documentation":"

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

" }, "introspectionConfig":{ "shape":"GraphQLApiIntrospectionConfig", "documentation":"

Sets the value of the GraphQL API to enable (`ENABLED`) or disable (`DISABLED`) introspection. If no value is provided, the introspection configuration will be set to `ENABLED` by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection.

" }, "queryDepthLimit":{ "shape":"QueryDepthLimit", "documentation":"

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is `0` (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between `1` and `75` nested levels. This field will produce a limit error if the operation falls out of bounds.

Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

" }, "resolverCountLimit":{ "shape":"ResolverCountLimit", "documentation":"

The maximum number of resolvers that can be invoked in a single request. The default value is `0` (or unspecified), which will set the limit to `10000`. When specified, the limit value can be between `1` and `10000`. This field will produce a limit error if the operation falls out of bounds.

" } } }, "UpdateGraphqlApiResponse":{ "type":"structure", "members":{ "graphqlApi":{ "shape":"GraphqlApi", "documentation":"

The updated `GraphqlApi` object.

" } } }, "UpdateResolverRequest":{ "type":"structure", "required":[ "apiId", "typeName", "fieldName" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "typeName":{ "shape":"ResourceName", "documentation":"

The new type name.

", "location":"uri", "locationName":"typeName" }, "fieldName":{ "shape":"ResourceName", "documentation":"

The new field name.

", "location":"uri", "locationName":"fieldName" }, "dataSourceName":{ "shape":"ResourceName", "documentation":"

The new data source name.

" }, "requestMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The new request mapping template.

A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

" }, "responseMappingTemplate":{ "shape":"MappingTemplate", "documentation":"

The new response mapping template.

" }, "kind":{ "shape":"ResolverKind", "documentation":"

The resolver type.

- UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.

- PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of `Function` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

" }, "pipelineConfig":{ "shape":"PipelineConfig", "documentation":"

The `PipelineConfig`.

" }, "syncConfig":{ "shape":"SyncConfig", "documentation":"

The `SyncConfig` for a resolver attached to a versioned data source.

" }, "cachingConfig":{ "shape":"CachingConfig", "documentation":"

The caching configuration for the resolver.

" }, "maxBatchSize":{ "shape":"MaxBatchSize", "documentation":"

The maximum batching size for a resolver.

" }, "runtime":{"shape":"AppSyncRuntime"}, "code":{ "shape":"Code", "documentation":"

The `resolver` code that contains the request and response functions. When code is used, the `runtime` is required. The `runtime` value must be `APPSYNC_JS`.

" } } }, "UpdateResolverResponse":{ "type":"structure", "members":{ "resolver":{ "shape":"Resolver", "documentation":"

The updated `Resolver` object.

" } } }, "UpdateSourceApiAssociationRequest":{ "type":"structure", "required":[ "associationId", "mergedApiIdentifier" ], "members":{ "associationId":{ "shape":"String", "documentation":"

The ID generated by the AppSync service for the source API association.

", "location":"uri", "locationName":"associationId" }, "mergedApiIdentifier":{ "shape":"String", "documentation":"

The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

", "location":"uri", "locationName":"mergedApiIdentifier" }, "description":{ "shape":"String", "documentation":"

The description field.

" }, "sourceApiAssociationConfig":{ "shape":"SourceApiAssociationConfig", "documentation":"

The `SourceApiAssociationConfig` object data.

" } } }, "UpdateSourceApiAssociationResponse":{ "type":"structure", "members":{ "sourceApiAssociation":{ "shape":"SourceApiAssociation", "documentation":"

The `SourceApiAssociation` object data.

" } } }, "UpdateTypeRequest":{ "type":"structure", "required":[ "apiId", "typeName", "format" ], "members":{ "apiId":{ "shape":"String", "documentation":"

The API ID.

", "location":"uri", "locationName":"apiId" }, "typeName":{ "shape":"ResourceName", "documentation":"

The new type name.

", "location":"uri", "locationName":"typeName" }, "definition":{ "shape":"String", "documentation":"

The new definition.

" }, "format":{ "shape":"TypeDefinitionFormat", "documentation":"

The new type format: SDL or JSON.

" } } }, "UpdateTypeResponse":{ "type":"structure", "members":{ "type":{ "shape":"Type", "documentation":"

The updated `Type` object.

" } } }, "UserPoolConfig":{ "type":"structure", "required":[ "userPoolId", "awsRegion", "defaultAction" ], "members":{ "userPoolId":{ "shape":"String", "documentation":"

The user pool ID.

" }, "awsRegion":{ "shape":"String", "documentation":"

The Amazon Web Services Region in which the user pool was created.

" }, "defaultAction":{ "shape":"DefaultAction", "documentation":"

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

" }, "appIdClientRegex":{ "shape":"String", "documentation":"

A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

" } }, "documentation":"

Describes an Amazon Cognito user pool configuration.

" } }, "documentation":"

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

" }