{ "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":{ "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 are executing 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.

" }, "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. Multiple functions can be used 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"} ], "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.

" }, "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"} ], "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.

" }, "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.

" }, "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.

" }, "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.

" }, "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.

" }, "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.

" }, "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.

" }, "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.

" }, "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. The key can be updated while it is 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.

" }, "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"} ], "documentation":"

Updates a Resolver object.

" }, "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 do not 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, AWS IAM, OIDC, or Amazon Cognito user pools.

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

The OpenID Connect configuration.

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

The Amazon Cognito user pool configuration.

" } }, "documentation":"

Describes an additional authentication provider.

" }, "AdditionalAuthenticationProviders":{ "type":"list", "member":{"shape":"AdditionalAuthenticationProvider"} }, "ApiCache":{ "type":"structure", "members":{ "ttl":{ "shape":"Long", "documentation":"

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

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

Caching behavior.

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

Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

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

At rest encryption flag for cache. This setting cannot be updated after creation.

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

The cache instance type. Valid values are

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:

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

The cache instance status.

" } }, "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 AWS AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:

da1: This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that date.

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

" }, "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 }, "AuthenticationType":{ "type":"string", "enum":[ "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS", "OPENID_CONNECT" ] }, "AuthorizationConfig":{ "type":"structure", "required":["authorizationType"], "members":{ "authorizationType":{ "shape":"AuthorizationType", "documentation":"

The authorization type required by the HTTP endpoint.

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

The AWS IAM settings.

" } }, "documentation":"

The authorization config in case the HTTP endpoint requires authorization.

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

The signing region for AWS IAM authorization.

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

The signing service name for AWS IAM authorization.

" } }, "documentation":"

The AWS IAM configuration.

" }, "BadRequestException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "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 }, "Blob":{"type":"blob"}, "Boolean":{"type":"boolean"}, "BooleanValue":{"type":"boolean"}, "CachingConfig":{ "type":"structure", "members":{ "ttl":{ "shape":"Long", "documentation":"

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

Valid values are between 1 and 3600 seconds.

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

The caching keys for a resolver that has caching enabled.

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

" } }, "documentation":"

The caching configuration for a resolver that has caching enabled.

" }, "CachingKeys":{ "type":"list", "member":{"shape":"String"} }, "CognitoUserPoolConfig":{ "type":"structure", "required":[ "userPoolId", "awsRegion" ], "members":{ "userPoolId":{ "shape":"String", "documentation":"

The user pool ID.

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

The AWS 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.

" } }, "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" ] }, "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 between 1 and 3600 seconds.

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

Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

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

At rest encryption flag for cache. This setting cannot be updated after creation.

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

Caching behavior.

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

The cache instance type. Valid values are

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:

" } }, "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":"

The time from creation 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 AWS IAM service role 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":"

AWS Lambda settings.

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

Amazon Elasticsearch Service settings.

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

HTTP endpoint settings.

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

Relational database settings.

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

The DataSource object.

" } } }, "CreateFunctionRequest":{ "type":"structure", "required":[ "apiId", "name", "dataSourceName", "functionVersion" ], "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.

" }, "syncConfig":{"shape":"SyncConfig"} } }, "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, AWS IAM, OIDC, or Amazon Cognito user pools.

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

The Amazon Cognito user pool configuration.

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

The OpenID Connect 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 enable X-Ray tracing for the GraphqlApi.

" } } }, "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 be used 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 a Lambda data source. For all other data sources, VTL request and response mapping templates are required.

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

The mapping template to be used for responses from the data source.

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

The resolver type.

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

The PipelineConfig.

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

The SyncConfig for a resolver attached to a versioned datasource.

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

The caching configuration for the resolver.

" } } }, "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 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.

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

The AWS IAM service role 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":"

AWS Lambda settings.

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

Amazon Elasticsearch Service settings.

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

HTTP endpoint settings.

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

Relational database settings.

" } }, "documentation":"

Describes a data source.

" }, "DataSourceType":{ "type":"string", "enum":[ "AWS_LAMBDA", "AMAZON_DYNAMODB", "AMAZON_ELASTICSEARCH", "NONE", "HTTP", "RELATIONAL_DATABASE" ] }, "DataSources":{ "type":"list", "member":{"shape":"DataSource"} }, "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":{ } }, "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 an Item is stored in the datasource.

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

The Delta Sync table name.

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

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

" } }, "documentation":"

Describes a Delta Sync configuration.

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

The table name.

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

The AWS 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 datasource.

" }, "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 AWS Region.

" } }, "documentation":"

Describes an Elasticsearch data source configuration.

" }, "ErrorMessage":{"type":"string"}, "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 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"} }, "documentation":"

A function is a reusable entity. Multiple functions can be used to compose the resolver logic.

" }, "Functions":{ "type":"list", "member":{"shape":"FunctionConfiguration"} }, "FunctionsIds":{ "type":"list", "member":{"shape":"String"} }, "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.

" }, "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.

" } } }, "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.

" } } }, "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.

" } } }, "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 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 representing whether X-Ray tracing is enabled for this GraphqlApi.

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

The ARN of the AWS Web Application Firewall (WAF) ACL associated with this GraphqlApi, if one exists.

" } }, "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 either specify the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.

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

The authorization config in case the HTTP endpoint requires authorization.

" } }, "documentation":"

Describes an HTTP data source configuration.

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

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

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "LambdaConflictHandlerConfig":{ "type":"structure", "members":{ "lambdaConflictHandlerArn":{ "shape":"String", "documentation":"

The 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 ARN for the Lambda function.

" } }, "documentation":"

Describes an AWS 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 can be used to return the next set of items in the list.

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

The maximum number of results 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 be passed 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 can be used to return the next set of items in the list.

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

The maximum number of results 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 be passed in the next request to this operation 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 can be used to return the next set of items in the list.

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

The maximum number of results 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 can be used 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 can be used to return the next set of items in the list.

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

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

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

The GraphqlApi objects.

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

An identifier to be passed 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 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 can be used 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 can be used to return the next set of items in the list.

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

The maximum number of results 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 be passed in the next request to this operation to return the next set of items in the list.

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

The GraphqlApi ARN.

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

A TagMap object.

" } } }, "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 can be used to return the next set of items in the list.

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

The maximum number of results 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 be passed 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.

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

The service role that AWS AppSync will assume to publish to Amazon 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 CloudWatch Logs configuration.

" }, "Long":{"type":"long"}, "MapOfStringToString":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "MappingTemplate":{ "type":"string", "max":65536, "min":1 }, "MaxResults":{ "type":"integer", "max":25, "min":0 }, "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 OpenID Connect 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 the AWS AppSync can validate against multiple client identifiers at a time.

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

The number of milliseconds a token is valid after being issued to a user.

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

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

" } }, "documentation":"

Describes an OpenID Connect configuration.

" }, "OutputType":{ "type":"string", "enum":[ "SDL", "JSON" ] }, "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.

" }, "RdsHttpEndpointConfig":{ "type":"structure", "members":{ "awsRegion":{ "shape":"String", "documentation":"

AWS Region for RDS HTTP endpoint.

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

Amazon RDS cluster ARN.

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

Logical database name.

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

Logical schema name.

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

AWS secret store ARN for database credentials.

" } }, "documentation":"

The Amazon RDS HTTP endpoint configuration.

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

Source type for the relational database.

" }, "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 ARN.

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

The request mapping template.

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

The response mapping template.

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

The resolver type.

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

The PipelineConfig.

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

The SyncConfig for a resolver attached to a versioned datasource.

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

The caching configuration for the resolver.

" } }, "documentation":"

Describes a resolver.

" }, "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]*" }, "SchemaStatus":{ "type":"string", "enum":[ "PROCESSING", "ACTIVE", "DELETING", "FAILED", "SUCCESS", "NOT_APPLICABLE" ] }, "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.

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

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

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

The Conflict Detection strategy to use.

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

The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

" } }, "documentation":"

Describes a Sync configuration for a resolver.

Contains information on which Conflict Detection as well as Resolution strategy should be performed when the resolver is invoked.

" }, "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 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 }, "Type":{ "type":"structure", "members":{ "name":{ "shape":"ResourceName", "documentation":"

The type name.

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

The type description.

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

The type 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 are not authorized to perform this operation.

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

The GraphqlApi 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 between 1 and 3600 seconds.

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

Caching behavior.

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

The cache instance type. Valid values are

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:

" } }, "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":"

The time from update 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 ARN for the data source.

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

The new Amazon DynamoDB configuration.

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

The new AWS Lambda configuration.

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

The new Elasticsearch Service configuration.

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

The new HTTP endpoint configuration.

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

The new relational database configuration.

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

The updated DataSource object.

" } } }, "UpdateFunctionRequest":{ "type":"structure", "required":[ "apiId", "name", "functionId", "dataSourceName", "functionVersion" ], "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.

" }, "syncConfig":{"shape":"SyncConfig"} } }, "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 enable X-Ray tracing for the GraphqlApi.

" } } }, "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 a 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.

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

The PipelineConfig.

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

The SyncConfig for a resolver attached to a versioned datasource.

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

The caching configuration for the resolver.

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

The updated Resolver object.

" } } }, "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 AWS 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.

" } }, "documentation":"

Describes an Amazon Cognito user pool configuration.

" } }, "documentation":"

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

" }