{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.appsync#AWSDeepdishControlPlaneService": { "type": "service", "version": "2017-07-25", "operations": [ { "target": "com.amazonaws.appsync#CreateApiCache" }, { "target": "com.amazonaws.appsync#CreateApiKey" }, { "target": "com.amazonaws.appsync#CreateDataSource" }, { "target": "com.amazonaws.appsync#CreateFunction" }, { "target": "com.amazonaws.appsync#CreateGraphqlApi" }, { "target": "com.amazonaws.appsync#CreateResolver" }, { "target": "com.amazonaws.appsync#CreateType" }, { "target": "com.amazonaws.appsync#DeleteApiCache" }, { "target": "com.amazonaws.appsync#DeleteApiKey" }, { "target": "com.amazonaws.appsync#DeleteDataSource" }, { "target": "com.amazonaws.appsync#DeleteFunction" }, { "target": "com.amazonaws.appsync#DeleteGraphqlApi" }, { "target": "com.amazonaws.appsync#DeleteResolver" }, { "target": "com.amazonaws.appsync#DeleteType" }, { "target": "com.amazonaws.appsync#FlushApiCache" }, { "target": "com.amazonaws.appsync#GetApiCache" }, { "target": "com.amazonaws.appsync#GetDataSource" }, { "target": "com.amazonaws.appsync#GetFunction" }, { "target": "com.amazonaws.appsync#GetGraphqlApi" }, { "target": "com.amazonaws.appsync#GetIntrospectionSchema" }, { "target": "com.amazonaws.appsync#GetResolver" }, { "target": "com.amazonaws.appsync#GetSchemaCreationStatus" }, { "target": "com.amazonaws.appsync#GetType" }, { "target": "com.amazonaws.appsync#ListApiKeys" }, { "target": "com.amazonaws.appsync#ListDataSources" }, { "target": "com.amazonaws.appsync#ListFunctions" }, { "target": "com.amazonaws.appsync#ListGraphqlApis" }, { "target": "com.amazonaws.appsync#ListResolvers" }, { "target": "com.amazonaws.appsync#ListResolversByFunction" }, { "target": "com.amazonaws.appsync#ListTagsForResource" }, { "target": "com.amazonaws.appsync#ListTypes" }, { "target": "com.amazonaws.appsync#StartSchemaCreation" }, { "target": "com.amazonaws.appsync#TagResource" }, { "target": "com.amazonaws.appsync#UntagResource" }, { "target": "com.amazonaws.appsync#UpdateApiCache" }, { "target": "com.amazonaws.appsync#UpdateApiKey" }, { "target": "com.amazonaws.appsync#UpdateDataSource" }, { "target": "com.amazonaws.appsync#UpdateFunction" }, { "target": "com.amazonaws.appsync#UpdateGraphqlApi" }, { "target": "com.amazonaws.appsync#UpdateResolver" }, { "target": "com.amazonaws.appsync#UpdateType" } ], "traits": { "aws.api#service": { "sdkId": "AppSync", "arnNamespace": "appsync", "cloudFormationName": "AppSync", "cloudTrailEventSource": "appsync.amazonaws.com", "endpointPrefix": "appsync" }, "aws.auth#sigv4": { "name": "appsync" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "
AWS AppSync provides API actions for creating and interacting with data sources using\n GraphQL from your application.
", "smithy.api#title": "AWS AppSync", "smithy.api#xmlNamespace": { "uri": "http://appsync.amazonaws.com" } } }, "com.amazonaws.appsync#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.appsync#String" } }, "traits": { "smithy.api#documentation": "You do not have access to perform this operation on this resource.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.appsync#AdditionalAuthenticationProvider": { "type": "structure", "members": { "authenticationType": { "target": "com.amazonaws.appsync#AuthenticationType", "traits": { "smithy.api#documentation": "The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
" } }, "openIDConnectConfig": { "target": "com.amazonaws.appsync#OpenIDConnectConfig", "traits": { "smithy.api#documentation": "The OpenID Connect configuration.
" } }, "userPoolConfig": { "target": "com.amazonaws.appsync#CognitoUserPoolConfig", "traits": { "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" } } }, "traits": { "smithy.api#documentation": "Describes an additional authentication provider.
" } }, "com.amazonaws.appsync#AdditionalAuthenticationProviders": { "type": "list", "member": { "target": "com.amazonaws.appsync#AdditionalAuthenticationProvider" } }, "com.amazonaws.appsync#ApiCache": { "type": "structure", "members": { "ttl": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "TTL in seconds for cache entries.
\nValid values are between 1 and 3600 seconds.
" } }, "apiCachingBehavior": { "target": "com.amazonaws.appsync#ApiCachingBehavior", "traits": { "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully\n cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers\n that you specify are cached.
\nTransit encryption flag when connecting to cache. This setting cannot be updated after\n creation.
" } }, "atRestEncryptionEnabled": { "target": "com.amazonaws.appsync#Boolean", "traits": { "smithy.api#documentation": "At rest encryption flag for cache. This setting cannot be updated after creation.
" } }, "type": { "target": "com.amazonaws.appsync#ApiCacheType", "traits": { "smithy.api#documentation": "The cache instance type. Valid values are
\n\n SMALL
\n
\n MEDIUM
\n
\n LARGE
\n
\n XLARGE
\n
\n LARGE_2X
\n
\n LARGE_4X
\n
\n LARGE_8X
(not available in all regions)
\n LARGE_12X
\n
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.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nThe cache instance status.
\n\n AVAILABLE: The instance is available for\n use.
\n\n CREATING: The instance is currently\n creating.
\n\n DELETING: The instance is currently\n deleting.
\n\n MODIFYING: The instance is currently\n modifying.
\n\n FAILED: The instance has failed\n creation.
\nThe ApiCache
object.
The API key ID.
" } }, "description": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "A description of the purpose of the API key.
" } }, "expires": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "The time after which the API key expires. The date is represented as seconds since the\n epoch, rounded down to the nearest hour.
" } }, "deletes": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "The time after which the API key is deleted. The date is represented as seconds since the\n epoch, rounded down to the nearest hour.
" } } }, "traits": { "smithy.api#documentation": "Describes an API key.
\nCustomers invoke AWS AppSync GraphQL API operations with API keys as an identity\n mechanism. There are two key versions:
\n\n da1: This version was introduced at launch in November\n 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB\n TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that\n date.
\n\n ListApiKeys
returns the expiration time in milliseconds.
\n CreateApiKey
returns the expiration time in\n milliseconds.
\n UpdateApiKey
is not available for this key version.
\n DeleteApiKey
deletes the item from the table.
Expiration is stored in Amazon DynamoDB as milliseconds. This results in a bug\n where keys are not automatically deleted because DynamoDB expects the TTL to be\n stored in seconds. As a one-time action, we will delete these keys from the table\n after February 21, 2018.
\n\n da2: This version was introduced in February 2018 when\n AppSync added support to extend key expiration.
\n\n ListApiKeys
returns the expiration time and deletion time\n in seconds.
\n CreateApiKey
returns the expiration time and deletion time\n in seconds and accepts a user-provided expiration time in seconds.
\n UpdateApiKey
returns the expiration time and and deletion time\n in seconds and accepts a user-provided expiration time in seconds. Expired API keys\n are kept for 60 days after the expiration time. Key expiration time can be updated\n while the key is not deleted.
\n DeleteApiKey
deletes the item from the table.
Expiration is stored in Amazon DynamoDB as seconds. After the expiration\n time, using the key to authenticate will fail. But the key can be reinstated before\n deletion.
\nDeletion is stored in Amazon DynamoDB as seconds. The key will be deleted\n after deletion time.
\nThe API key exceeded a limit. Try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.appsync#ApiKeyValidityOutOfBoundsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.appsync#String" } }, "traits": { "smithy.api#documentation": "The API key expiration must be set to a value between 1 and 365 days from creation (for\n CreateApiKey
) or from update (for UpdateApiKey
).
The GraphQL API exceeded a limit. Try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.appsync#AuthenticationType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "API_KEY", "name": "API_KEY" }, { "value": "AWS_IAM", "name": "AWS_IAM" }, { "value": "AMAZON_COGNITO_USER_POOLS", "name": "AMAZON_COGNITO_USER_POOLS" }, { "value": "OPENID_CONNECT", "name": "OPENID_CONNECT" } ] } }, "com.amazonaws.appsync#AuthorizationConfig": { "type": "structure", "members": { "authorizationType": { "target": "com.amazonaws.appsync#AuthorizationType", "traits": { "smithy.api#documentation": "The authorization type required by the HTTP endpoint.
\n\n AWS_IAM: The authorization type is\n Sigv4.
\nThe AWS IAM settings.
" } } }, "traits": { "smithy.api#documentation": "The authorization config in case the HTTP endpoint requires authorization.
" } }, "com.amazonaws.appsync#AuthorizationType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AWS_IAM", "name": "AWS_IAM" } ] } }, "com.amazonaws.appsync#AwsIamConfig": { "type": "structure", "members": { "signingRegion": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The signing region for AWS IAM authorization.
" } }, "signingServiceName": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The signing service name for AWS IAM authorization.
" } } }, "traits": { "smithy.api#documentation": "The AWS IAM configuration.
" } }, "com.amazonaws.appsync#BadRequestException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.appsync#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The request is not well formed. For example, a value is invalid or a required field is\n missing. Check the field values, and then try again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.appsync#Blob": { "type": "blob" }, "com.amazonaws.appsync#Boolean": { "type": "boolean" }, "com.amazonaws.appsync#BooleanValue": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.appsync#CachingConfig": { "type": "structure", "members": { "ttl": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "The TTL in seconds for a resolver that has caching enabled.
\nValid values are between 1 and 3600 seconds.
" } }, "cachingKeys": { "target": "com.amazonaws.appsync#CachingKeys", "traits": { "smithy.api#documentation": "The caching keys for a resolver that has caching enabled.
\nValid values are entries from the $context.arguments
,\n $context.source
, and $context.identity
maps.
The caching configuration for a resolver that has caching enabled.
" } }, "com.amazonaws.appsync#CachingKeys": { "type": "list", "member": { "target": "com.amazonaws.appsync#String" } }, "com.amazonaws.appsync#CognitoUserPoolConfig": { "type": "structure", "members": { "userPoolId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The user pool ID.
", "smithy.api#required": {} } }, "awsRegion": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The AWS Region in which the user pool was created.
", "smithy.api#required": {} } }, "appIdClientRegex": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client\n ID.
" } } }, "traits": { "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" } }, "com.amazonaws.appsync#ConcurrentModificationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.appsync#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Another modification is in progress at this time and it must complete before you can\n make your change.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.appsync#ConflictDetectionType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "VERSION", "name": "VERSION" }, { "value": "NONE", "name": "NONE" } ] } }, "com.amazonaws.appsync#ConflictHandlerType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "OPTIMISTIC_CONCURRENCY", "name": "OPTIMISTIC_CONCURRENCY" }, { "value": "LAMBDA", "name": "LAMBDA" }, { "value": "AUTOMERGE", "name": "AUTOMERGE" }, { "value": "NONE", "name": "NONE" } ] } }, "com.amazonaws.appsync#CreateApiCache": { "type": "operation", "input": { "target": "com.amazonaws.appsync#CreateApiCacheRequest" }, "output": { "target": "com.amazonaws.appsync#CreateApiCacheResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a cache for the GraphQL API.
", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/ApiCaches", "code": 200 } } }, "com.amazonaws.appsync#CreateApiCacheRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The GraphQL API Id.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ttl": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "TTL in seconds for cache entries.
\nValid values are between 1 and 3600 seconds.
", "smithy.api#required": {} } }, "transitEncryptionEnabled": { "target": "com.amazonaws.appsync#Boolean", "traits": { "smithy.api#documentation": "Transit encryption flag when connecting to cache. This setting cannot be updated after\n creation.
" } }, "atRestEncryptionEnabled": { "target": "com.amazonaws.appsync#Boolean", "traits": { "smithy.api#documentation": "At rest encryption flag for cache. This setting cannot be updated after creation.
" } }, "apiCachingBehavior": { "target": "com.amazonaws.appsync#ApiCachingBehavior", "traits": { "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully\n cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers\n that you specify are cached.
\nThe cache instance type. Valid values are
\n\n SMALL
\n
\n MEDIUM
\n
\n LARGE
\n
\n XLARGE
\n
\n LARGE_2X
\n
\n LARGE_4X
\n
\n LARGE_8X
(not available in all regions)
\n LARGE_12X
\n
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.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nRepresents the input of a CreateApiCache
operation.
The ApiCache
object.
Represents the output of a CreateApiCache
operation.
Creates a unique key that you can distribute to clients who are executing your\n API.
", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/apikeys", "code": 200 } } }, "com.amazonaws.appsync#CreateApiKeyRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The ID for your GraphQL API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "A description of the purpose of the API key.
" } }, "expires": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "The time from creation time after which the API key expires. The date is represented as\n seconds since the epoch, rounded down to the nearest hour. The default value for this\n parameter is 7 days from creation time. For more information, see .
" } } } }, "com.amazonaws.appsync#CreateApiKeyResponse": { "type": "structure", "members": { "apiKey": { "target": "com.amazonaws.appsync#ApiKey", "traits": { "smithy.api#documentation": "The API key.
" } } } }, "com.amazonaws.appsync#CreateDataSource": { "type": "operation", "input": { "target": "com.amazonaws.appsync#CreateDataSourceRequest" }, "output": { "target": "com.amazonaws.appsync#CreateDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a DataSource
object.
The API ID for the GraphQL API for the DataSource
.
A user-supplied name for the DataSource
.
A description of the DataSource
.
The type of the DataSource
.
The AWS IAM service role ARN for the data source. The system assumes this role when\n accessing the data source.
" } }, "dynamodbConfig": { "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", "traits": { "smithy.api#documentation": "Amazon DynamoDB settings.
" } }, "lambdaConfig": { "target": "com.amazonaws.appsync#LambdaDataSourceConfig", "traits": { "smithy.api#documentation": "AWS Lambda settings.
" } }, "elasticsearchConfig": { "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", "traits": { "smithy.api#documentation": "Amazon Elasticsearch Service settings.
" } }, "httpConfig": { "target": "com.amazonaws.appsync#HttpDataSourceConfig", "traits": { "smithy.api#documentation": "HTTP endpoint settings.
" } }, "relationalDatabaseConfig": { "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", "traits": { "smithy.api#documentation": "Relational database settings.
" } } } }, "com.amazonaws.appsync#CreateDataSourceResponse": { "type": "structure", "members": { "dataSource": { "target": "com.amazonaws.appsync#DataSource", "traits": { "smithy.api#documentation": "The DataSource
object.
Creates a Function
object.
A function is a reusable entity. Multiple functions can be used to compose the resolver\n logic.
", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/functions", "code": 200 } } }, "com.amazonaws.appsync#CreateFunctionRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The GraphQL API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The Function
name. The function name does not have to be unique.
The Function
description.
The Function
\n DataSource
name.
The Function
request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.
The Function
response mapping template.
The version
of the request mapping template. Currently the supported value\n is 2018-05-29.
The Function
object.
Creates a GraphqlApi
object.
A user-supplied name for the GraphqlApi
.
The Amazon CloudWatch Logs configuration.
" } }, "authenticationType": { "target": "com.amazonaws.appsync#AuthenticationType", "traits": { "smithy.api#documentation": "The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
", "smithy.api#required": {} } }, "userPoolConfig": { "target": "com.amazonaws.appsync#UserPoolConfig", "traits": { "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" } }, "openIDConnectConfig": { "target": "com.amazonaws.appsync#OpenIDConnectConfig", "traits": { "smithy.api#documentation": "The OpenID Connect configuration.
" } }, "tags": { "target": "com.amazonaws.appsync#TagMap", "traits": { "smithy.api#documentation": "A TagMap
object.
A list of additional authentication providers for the GraphqlApi
\n API.
A flag indicating whether to enable X-Ray tracing for the\n GraphqlApi
.
The GraphqlApi
.
Creates a Resolver
object.
A resolver converts incoming requests into a format that a data source can understand\n and converts the data source's responses into GraphQL.
", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", "code": 200 } } }, "com.amazonaws.appsync#CreateResolverRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The ID for the GraphQL API for which the resolver is being created.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "typeName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The name of the Type
.
The name of the field to attach the resolver to.
", "smithy.api#required": {} } }, "dataSourceName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The name of the data source for which the resolver is being created.
" } }, "requestMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { "smithy.api#documentation": "The mapping template to be used for requests.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).
\nVTL request mapping templates are optional when using a Lambda data source. For all\n other data sources, VTL request and response mapping templates are required.
" } }, "responseMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { "smithy.api#documentation": "The mapping template to be used for responses from the data source.
" } }, "kind": { "target": "com.amazonaws.appsync#ResolverKind", "traits": { "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. A UNIT resolver enables you to execute a GraphQL query\n against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. A PIPELINE\n resolver enables you to execute a series of Function
in a serial manner.\n You can use a pipeline resolver to execute a GraphQL query against multiple data\n sources.
The PipelineConfig
.
The SyncConfig
for a resolver attached to a versioned datasource.
The caching configuration for the resolver.
" } } } }, "com.amazonaws.appsync#CreateResolverResponse": { "type": "structure", "members": { "resolver": { "target": "com.amazonaws.appsync#Resolver", "traits": { "smithy.api#documentation": "The Resolver
object.
Creates a Type
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "definition": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The type definition, in GraphQL Schema Definition Language (SDL) format.
\nFor more information, see the GraphQL SDL\n documentation.
", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.appsync#TypeDefinitionFormat", "traits": { "smithy.api#documentation": "The type format: SDL or JSON.
", "smithy.api#required": {} } } } }, "com.amazonaws.appsync#CreateTypeResponse": { "type": "structure", "members": { "type": { "target": "com.amazonaws.appsync#Type", "traits": { "smithy.api#documentation": "The Type
object.
The data source ARN.
" } }, "name": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The name of the data source.
" } }, "description": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The description of the data source.
" } }, "type": { "target": "com.amazonaws.appsync#DataSourceType", "traits": { "smithy.api#documentation": "The type of the data source.
\n\n AMAZON_DYNAMODB: The data source is an Amazon\n DynamoDB table.
\n\n AMAZON_ELASTICSEARCH: The data source is an\n Amazon Elasticsearch Service domain.
\n\n AWS_LAMBDA: The data source is an AWS Lambda\n function.
\n\n NONE: There is no data source. This type is\n used when you wish to invoke a GraphQL operation without connecting to a data source,\n such as performing data transformation with resolvers or triggering a subscription to\n be invoked from a mutation.
\n\n HTTP: The data source is an HTTP\n endpoint.
\n\n RELATIONAL_DATABASE: The data source is a\n relational database.
\nThe AWS IAM service role ARN for the data source. The system assumes this role when\n accessing the data source.
" } }, "dynamodbConfig": { "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", "traits": { "smithy.api#documentation": "Amazon DynamoDB settings.
" } }, "lambdaConfig": { "target": "com.amazonaws.appsync#LambdaDataSourceConfig", "traits": { "smithy.api#documentation": "AWS Lambda settings.
" } }, "elasticsearchConfig": { "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", "traits": { "smithy.api#documentation": "Amazon Elasticsearch Service settings.
" } }, "httpConfig": { "target": "com.amazonaws.appsync#HttpDataSourceConfig", "traits": { "smithy.api#documentation": "HTTP endpoint settings.
" } }, "relationalDatabaseConfig": { "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", "traits": { "smithy.api#documentation": "Relational database settings.
" } } }, "traits": { "smithy.api#documentation": "Describes a data source.
" } }, "com.amazonaws.appsync#DataSourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AWS_LAMBDA", "name": "AWS_LAMBDA" }, { "value": "AMAZON_DYNAMODB", "name": "AMAZON_DYNAMODB" }, { "value": "AMAZON_ELASTICSEARCH", "name": "AMAZON_ELASTICSEARCH" }, { "value": "NONE", "name": "NONE" }, { "value": "HTTP", "name": "HTTP" }, { "value": "RELATIONAL_DATABASE", "name": "RELATIONAL_DATABASE" } ] } }, "com.amazonaws.appsync#DataSources": { "type": "list", "member": { "target": "com.amazonaws.appsync#DataSource" } }, "com.amazonaws.appsync#DefaultAction": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ALLOW", "name": "ALLOW" }, { "value": "DENY", "name": "DENY" } ] } }, "com.amazonaws.appsync#DeleteApiCache": { "type": "operation", "input": { "target": "com.amazonaws.appsync#DeleteApiCacheRequest" }, "output": { "target": "com.amazonaws.appsync#DeleteApiCacheResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes an ApiCache
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input of a DeleteApiCache
operation.
Represents the output of a DeleteApiCache
operation.
Deletes an API key.
", "smithy.api#http": { "method": "DELETE", "uri": "/v1/apis/{apiId}/apikeys/{id}", "code": 200 } } }, "com.amazonaws.appsync#DeleteApiKeyRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The ID for the API key.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.appsync#DeleteApiKeyResponse": { "type": "structure", "members": {} }, "com.amazonaws.appsync#DeleteDataSource": { "type": "operation", "input": { "target": "com.amazonaws.appsync#DeleteDataSourceRequest" }, "output": { "target": "com.amazonaws.appsync#DeleteDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a DataSource
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The name of the data source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.appsync#DeleteDataSourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.appsync#DeleteFunction": { "type": "operation", "input": { "target": "com.amazonaws.appsync#DeleteFunctionRequest" }, "output": { "target": "com.amazonaws.appsync#DeleteFunctionResponse" }, "errors": [ { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a Function
.
The GraphQL API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "functionId": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The Function
ID.
Deletes a GraphqlApi
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.appsync#DeleteGraphqlApiResponse": { "type": "structure", "members": {} }, "com.amazonaws.appsync#DeleteResolver": { "type": "operation", "input": { "target": "com.amazonaws.appsync#DeleteResolverRequest" }, "output": { "target": "com.amazonaws.appsync#DeleteResolverResponse" }, "errors": [ { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a Resolver
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "typeName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The name of the resolver type.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fieldName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The resolver field name.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.appsync#DeleteResolverResponse": { "type": "structure", "members": {} }, "com.amazonaws.appsync#DeleteType": { "type": "operation", "input": { "target": "com.amazonaws.appsync#DeleteTypeRequest" }, "output": { "target": "com.amazonaws.appsync#DeleteTypeResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a Type
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "typeName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The type name.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.appsync#DeleteTypeResponse": { "type": "structure", "members": {} }, "com.amazonaws.appsync#DeltaSyncConfig": { "type": "structure", "members": { "baseTableTTL": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "The number of minutes an Item is stored in the datasource.
" } }, "deltaSyncTableName": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The Delta Sync table name.
" } }, "deltaSyncTableTTL": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
" } } }, "traits": { "smithy.api#documentation": "Describes a Delta Sync configuration.
" } }, "com.amazonaws.appsync#DynamodbDataSourceConfig": { "type": "structure", "members": { "tableName": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The table name.
", "smithy.api#required": {} } }, "awsRegion": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The AWS Region.
", "smithy.api#required": {} } }, "useCallerCredentials": { "target": "com.amazonaws.appsync#Boolean", "traits": { "smithy.api#documentation": "Set to TRUE to use Amazon Cognito credentials with this data source.
" } }, "deltaSyncConfig": { "target": "com.amazonaws.appsync#DeltaSyncConfig", "traits": { "smithy.api#documentation": "The DeltaSyncConfig
for a versioned datasource.
Set to TRUE to use Conflict Detection and Resolution with this data source.
" } } }, "traits": { "smithy.api#documentation": "Describes an Amazon DynamoDB data source configuration.
" } }, "com.amazonaws.appsync#ElasticsearchDataSourceConfig": { "type": "structure", "members": { "endpoint": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The endpoint.
", "smithy.api#required": {} } }, "awsRegion": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The AWS Region.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes an Elasticsearch data source configuration.
" } }, "com.amazonaws.appsync#ErrorMessage": { "type": "string" }, "com.amazonaws.appsync#FieldLogLevel": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NONE", "name": "NONE" }, { "value": "ERROR", "name": "ERROR" }, { "value": "ALL", "name": "ALL" } ] } }, "com.amazonaws.appsync#FlushApiCache": { "type": "operation", "input": { "target": "com.amazonaws.appsync#FlushApiCacheRequest" }, "output": { "target": "com.amazonaws.appsync#FlushApiCacheResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Flushes an ApiCache
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input of a FlushApiCache
operation.
Represents the output of a FlushApiCache
operation.
A unique ID representing the Function
object.
The ARN of the Function
object.
The name of the Function
object.
The Function
description.
The name of the DataSource
.
The Function
request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.
The Function
response mapping template.
The version of the request mapping template. Currently only the 2018-05-29 version of\n the template is supported.
" } }, "syncConfig": { "target": "com.amazonaws.appsync#SyncConfig" } }, "traits": { "smithy.api#documentation": "A function is a reusable entity. Multiple functions can be used to compose the resolver\n logic.
" } }, "com.amazonaws.appsync#Functions": { "type": "list", "member": { "target": "com.amazonaws.appsync#FunctionConfiguration" } }, "com.amazonaws.appsync#FunctionsIds": { "type": "list", "member": { "target": "com.amazonaws.appsync#String" } }, "com.amazonaws.appsync#GetApiCache": { "type": "operation", "input": { "target": "com.amazonaws.appsync#GetApiCacheRequest" }, "output": { "target": "com.amazonaws.appsync#GetApiCacheResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves an ApiCache
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input of a GetApiCache
operation.
The ApiCache
object.
Represents the output of a GetApiCache
operation.
Retrieves a DataSource
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The name of the data source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.appsync#GetDataSourceResponse": { "type": "structure", "members": { "dataSource": { "target": "com.amazonaws.appsync#DataSource", "traits": { "smithy.api#documentation": "The DataSource
object.
Get a Function
.
The GraphQL API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "functionId": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The Function
ID.
The Function
object.
Retrieves a GraphqlApi
object.
The API ID for the GraphQL API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.appsync#GetGraphqlApiResponse": { "type": "structure", "members": { "graphqlApi": { "target": "com.amazonaws.appsync#GraphqlApi", "traits": { "smithy.api#documentation": "The GraphqlApi
object.
Retrieves the introspection schema for a GraphQL API.
", "smithy.api#http": { "method": "GET", "uri": "/v1/apis/{apiId}/schema", "code": 200 } } }, "com.amazonaws.appsync#GetIntrospectionSchemaRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.appsync#OutputType", "traits": { "smithy.api#documentation": "The schema format: SDL or JSON.
", "smithy.api#httpQuery": "format", "smithy.api#required": {} } }, "includeDirectives": { "target": "com.amazonaws.appsync#BooleanValue", "traits": { "smithy.api#documentation": "A flag that specifies whether the schema introspection should contain directives.
", "smithy.api#httpQuery": "includeDirectives" } } } }, "com.amazonaws.appsync#GetIntrospectionSchemaResponse": { "type": "structure", "members": { "schema": { "target": "com.amazonaws.appsync#Blob", "traits": { "smithy.api#documentation": "The schema, in GraphQL Schema Definition Language (SDL) format.
\nFor more information, see the GraphQL SDL\n documentation.
", "smithy.api#httpPayload": {} } } } }, "com.amazonaws.appsync#GetResolver": { "type": "operation", "input": { "target": "com.amazonaws.appsync#GetResolverRequest" }, "output": { "target": "com.amazonaws.appsync#GetResolverResponse" }, "errors": [ { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves a Resolver
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "typeName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The resolver type name.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fieldName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The resolver field name.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.appsync#GetResolverResponse": { "type": "structure", "members": { "resolver": { "target": "com.amazonaws.appsync#Resolver", "traits": { "smithy.api#documentation": "The Resolver
object.
Retrieves the current status of a schema creation operation.
", "smithy.api#http": { "method": "GET", "uri": "/v1/apis/{apiId}/schemacreation", "code": 200 } } }, "com.amazonaws.appsync#GetSchemaCreationStatusRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.appsync#GetSchemaCreationStatusResponse": { "type": "structure", "members": { "status": { "target": "com.amazonaws.appsync#SchemaStatus", "traits": { "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When\n the schema is in the ACTIVE state, you can add data.
" } }, "details": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "Detailed information about the status of the schema creation operation.
" } } } }, "com.amazonaws.appsync#GetType": { "type": "operation", "input": { "target": "com.amazonaws.appsync#GetTypeRequest" }, "output": { "target": "com.amazonaws.appsync#GetTypeResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves a Type
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "typeName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The type name.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.appsync#TypeDefinitionFormat", "traits": { "smithy.api#documentation": "The type format: SDL or JSON.
", "smithy.api#httpQuery": "format", "smithy.api#required": {} } } } }, "com.amazonaws.appsync#GetTypeResponse": { "type": "structure", "members": { "type": { "target": "com.amazonaws.appsync#Type", "traits": { "smithy.api#documentation": "The Type
object.
The GraphQL schema is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.appsync#GraphqlApi": { "type": "structure", "members": { "name": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The API name.
" } }, "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The API ID.
" } }, "authenticationType": { "target": "com.amazonaws.appsync#AuthenticationType", "traits": { "smithy.api#documentation": "The authentication type.
" } }, "logConfig": { "target": "com.amazonaws.appsync#LogConfig", "traits": { "smithy.api#documentation": "The Amazon CloudWatch Logs configuration.
" } }, "userPoolConfig": { "target": "com.amazonaws.appsync#UserPoolConfig", "traits": { "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" } }, "openIDConnectConfig": { "target": "com.amazonaws.appsync#OpenIDConnectConfig", "traits": { "smithy.api#documentation": "The OpenID Connect configuration.
" } }, "arn": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The ARN.
" } }, "uris": { "target": "com.amazonaws.appsync#MapOfStringToString", "traits": { "smithy.api#documentation": "The URIs.
" } }, "tags": { "target": "com.amazonaws.appsync#TagMap", "traits": { "smithy.api#documentation": "The tags.
" } }, "additionalAuthenticationProviders": { "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", "traits": { "smithy.api#documentation": "A list of additional authentication providers for the GraphqlApi
\n API.
A flag representing whether X-Ray tracing is enabled for this\n GraphqlApi
.
The ARN of the AWS Web Application Firewall (WAF) ACL associated with this\n GraphqlApi
, if one exists.
Describes a GraphQL API.
" } }, "com.amazonaws.appsync#GraphqlApis": { "type": "list", "member": { "target": "com.amazonaws.appsync#GraphqlApi" } }, "com.amazonaws.appsync#HttpDataSourceConfig": { "type": "structure", "members": { "endpoint": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The HTTP URL endpoint. You can either specify the domain name or IP, and port\n combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS\n AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS\n endpoints.
" } }, "authorizationConfig": { "target": "com.amazonaws.appsync#AuthorizationConfig", "traits": { "smithy.api#documentation": "The authorization config in case the HTTP endpoint requires authorization.
" } } }, "traits": { "smithy.api#documentation": "Describes an HTTP data source configuration.
" } }, "com.amazonaws.appsync#InternalFailureException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.appsync#String" } }, "traits": { "smithy.api#documentation": "An internal AWS AppSync error occurred. Try your request again.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.appsync#LambdaConflictHandlerConfig": { "type": "structure", "members": { "lambdaConflictHandlerArn": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The Arn for the Lambda function to use as the Conflict Handler.
" } } }, "traits": { "smithy.api#documentation": "The LambdaConflictHandlerConfig
object when configuring LAMBDA as the\n Conflict Handler.
The ARN for the Lambda function.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes an AWS Lambda data source configuration.
" } }, "com.amazonaws.appsync#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.appsync#String" } }, "traits": { "smithy.api#documentation": "The request exceeded a limit. Try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.appsync#ListApiKeys": { "type": "operation", "input": { "target": "com.amazonaws.appsync#ListApiKeysRequest" }, "output": { "target": "com.amazonaws.appsync#ListApiKeysResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Lists the API keys for a given API.
\nAPI keys are deleted automatically 60 days after they expire. However, they may\n still be included in the response until they have actually been deleted. You can safely\n call DeleteApiKey
to manually delete a key before it's automatically\n deleted.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results you want the request to return.
", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.appsync#ListApiKeysResponse": { "type": "structure", "members": { "apiKeys": { "target": "com.amazonaws.appsync#ApiKeys", "traits": { "smithy.api#documentation": "The ApiKey
objects.
An identifier to be passed in the next request to this operation to return the next set\n of items in the list.
" } } } }, "com.amazonaws.appsync#ListDataSources": { "type": "operation", "input": { "target": "com.amazonaws.appsync#ListDataSourcesRequest" }, "output": { "target": "com.amazonaws.appsync#ListDataSourcesResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Lists the data sources for a given API.
", "smithy.api#http": { "method": "GET", "uri": "/v1/apis/{apiId}/datasources", "code": 200 } } }, "com.amazonaws.appsync#ListDataSourcesRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results you want the request to return.
", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.appsync#ListDataSourcesResponse": { "type": "structure", "members": { "dataSources": { "target": "com.amazonaws.appsync#DataSources", "traits": { "smithy.api#documentation": "The DataSource
objects.
An identifier to be passed in the next request to this operation to return the next set\n of items in the list.
" } } } }, "com.amazonaws.appsync#ListFunctions": { "type": "operation", "input": { "target": "com.amazonaws.appsync#ListFunctionsRequest" }, "output": { "target": "com.amazonaws.appsync#ListFunctionsResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "List multiple functions.
", "smithy.api#http": { "method": "GET", "uri": "/v1/apis/{apiId}/functions", "code": 200 } } }, "com.amazonaws.appsync#ListFunctionsRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The GraphQL API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results you want the request to return.
", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.appsync#ListFunctionsResponse": { "type": "structure", "members": { "functions": { "target": "com.amazonaws.appsync#Functions", "traits": { "smithy.api#documentation": "A list of Function
objects.
An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } } } }, "com.amazonaws.appsync#ListGraphqlApis": { "type": "operation", "input": { "target": "com.amazonaws.appsync#ListGraphqlApisRequest" }, "output": { "target": "com.amazonaws.appsync#ListGraphqlApisResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Lists your GraphQL APIs.
", "smithy.api#http": { "method": "GET", "uri": "/v1/apis", "code": 200 } } }, "com.amazonaws.appsync#ListGraphqlApisRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results you want the request to return.
", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.appsync#ListGraphqlApisResponse": { "type": "structure", "members": { "graphqlApis": { "target": "com.amazonaws.appsync#GraphqlApis", "traits": { "smithy.api#documentation": "The GraphqlApi
objects.
An identifier to be passed in the next request to this operation to return the next set\n of items in the list.
" } } } }, "com.amazonaws.appsync#ListResolvers": { "type": "operation", "input": { "target": "com.amazonaws.appsync#ListResolversRequest" }, "output": { "target": "com.amazonaws.appsync#ListResolversResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Lists the resolvers for a given API and type.
", "smithy.api#http": { "method": "GET", "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", "code": 200 } } }, "com.amazonaws.appsync#ListResolversByFunction": { "type": "operation", "input": { "target": "com.amazonaws.appsync#ListResolversByFunctionRequest" }, "output": { "target": "com.amazonaws.appsync#ListResolversByFunctionResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "List the resolvers that are associated with a specific function.
", "smithy.api#http": { "method": "GET", "uri": "/v1/apis/{apiId}/functions/{functionId}/resolvers", "code": 200 } } }, "com.amazonaws.appsync#ListResolversByFunctionRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "functionId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The Function ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results you want the request to return.
", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.appsync#ListResolversByFunctionResponse": { "type": "structure", "members": { "resolvers": { "target": "com.amazonaws.appsync#Resolvers", "traits": { "smithy.api#documentation": "The list of resolvers.
" } }, "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { "smithy.api#documentation": "An identifier that can be used to return the next set of items in the list.
" } } } }, "com.amazonaws.appsync#ListResolversRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "typeName": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The type name.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results you want the request to return.
", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.appsync#ListResolversResponse": { "type": "structure", "members": { "resolvers": { "target": "com.amazonaws.appsync#Resolvers", "traits": { "smithy.api#documentation": "The Resolver
objects.
An identifier to be passed in the next request to this operation to return the next set\n of items in the list.
" } } } }, "com.amazonaws.appsync#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.appsync#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.appsync#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.appsync#AccessDeniedException" }, { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#LimitExceededException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Lists the tags for a resource.
", "smithy.api#http": { "method": "GET", "uri": "/v1/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.appsync#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.appsync#ResourceArn", "traits": { "smithy.api#documentation": "The GraphqlApi
ARN.
A TagMap
object.
Lists the types for a given API.
", "smithy.api#http": { "method": "GET", "uri": "/v1/apis/{apiId}/types", "code": 200 } } }, "com.amazonaws.appsync#ListTypesRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.appsync#TypeDefinitionFormat", "traits": { "smithy.api#documentation": "The type format: SDL or JSON.
", "smithy.api#httpQuery": "format", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results you want the request to return.
", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.appsync#ListTypesResponse": { "type": "structure", "members": { "types": { "target": "com.amazonaws.appsync#TypeList", "traits": { "smithy.api#documentation": "The Type
objects.
An identifier to be passed in the next request to this operation to return the next set\n of items in the list.
" } } } }, "com.amazonaws.appsync#LogConfig": { "type": "structure", "members": { "fieldLogLevel": { "target": "com.amazonaws.appsync#FieldLogLevel", "traits": { "smithy.api#documentation": "The field logging level. Values can be NONE, ERROR, or ALL.
\n\n NONE: No field-level logs are\n captured.
\n\n ERROR: Logs the following information only for\n the fields that are in error:
\nThe error section in the server response.
\nField-level errors.
\nThe generated request/response functions that got resolved for error\n fields.
\n\n ALL: The following information is logged for\n all fields in the query:
\nField-level tracing information.
\nThe generated request/response functions that got resolved for each\n field.
\nThe service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in\n your account.
", "smithy.api#required": {} } }, "excludeVerboseContent": { "target": "com.amazonaws.appsync#Boolean", "traits": { "smithy.api#documentation": "Set to TRUE to exclude sections that contain information such as headers, context, and\n evaluated mapping templates, regardless of logging level.
" } } }, "traits": { "smithy.api#documentation": "The CloudWatch Logs configuration.
" } }, "com.amazonaws.appsync#Long": { "type": "long" }, "com.amazonaws.appsync#MapOfStringToString": { "type": "map", "key": { "target": "com.amazonaws.appsync#String" }, "value": { "target": "com.amazonaws.appsync#String" } }, "com.amazonaws.appsync#MappingTemplate": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 65536 } } }, "com.amazonaws.appsync#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 25 } } }, "com.amazonaws.appsync#NotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.appsync#String" } }, "traits": { "smithy.api#documentation": "The resource specified in the request was not found. Check the resource, and then try\n again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.appsync#OpenIDConnectConfig": { "type": "structure", "members": { "issuer": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The issuer for the OpenID Connect configuration. The issuer returned by discovery must\n exactly match the value of iss
in the ID token.
The client identifier of the Relying party at the OpenID identity provider. This\n identifier is typically obtained when the Relying party is registered with the OpenID\n identity provider. You can specify a regular expression so the AWS AppSync can validate\n against multiple client identifiers at a time.
" } }, "iatTTL": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "The number of milliseconds a token is valid after being issued to a user.
" } }, "authTTL": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "The number of milliseconds a token is valid after being authenticated.
" } } }, "traits": { "smithy.api#documentation": "Describes an OpenID Connect configuration.
" } }, "com.amazonaws.appsync#OutputType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SDL", "name": "SDL" }, { "value": "JSON", "name": "JSON" } ] } }, "com.amazonaws.appsync#PaginationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 65536 }, "smithy.api#pattern": "[\\\\S]+" } }, "com.amazonaws.appsync#PipelineConfig": { "type": "structure", "members": { "functions": { "target": "com.amazonaws.appsync#FunctionsIds", "traits": { "smithy.api#documentation": "A list of Function
objects.
The pipeline configuration for a resolver of kind PIPELINE
.
AWS Region for RDS HTTP endpoint.
" } }, "dbClusterIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "Amazon RDS cluster ARN.
" } }, "databaseName": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "Logical database name.
" } }, "schema": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "Logical schema name.
" } }, "awsSecretStoreArn": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "AWS secret store ARN for database credentials.
" } } }, "traits": { "smithy.api#documentation": "The Amazon RDS HTTP endpoint configuration.
" } }, "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig": { "type": "structure", "members": { "relationalDatabaseSourceType": { "target": "com.amazonaws.appsync#RelationalDatabaseSourceType", "traits": { "smithy.api#documentation": "Source type for the relational database.
\n\n RDS_HTTP_ENDPOINT: The relational database\n source type is an Amazon RDS HTTP endpoint.
\nAmazon RDS HTTP endpoint settings.
" } } }, "traits": { "smithy.api#documentation": "Describes a relational database data source configuration.
" } }, "com.amazonaws.appsync#RelationalDatabaseSourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "RDS_HTTP_ENDPOINT", "name": "RDS_HTTP_ENDPOINT" } ] } }, "com.amazonaws.appsync#Resolver": { "type": "structure", "members": { "typeName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The resolver type name.
" } }, "fieldName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The resolver field name.
" } }, "dataSourceName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The resolver data source name.
" } }, "resolverArn": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The resolver ARN.
" } }, "requestMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { "smithy.api#documentation": "The request mapping template.
" } }, "responseMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { "smithy.api#documentation": "The response mapping template.
" } }, "kind": { "target": "com.amazonaws.appsync#ResolverKind", "traits": { "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. A UNIT resolver enables you to execute a GraphQL query\n against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. A PIPELINE\n resolver enables you to execute a series of Function
in a serial manner.\n You can use a pipeline resolver to execute a GraphQL query against multiple data\n sources.
The PipelineConfig
.
The SyncConfig
for a resolver attached to a versioned datasource.
The caching configuration for the resolver.
" } } }, "traits": { "smithy.api#documentation": "Describes a resolver.
" } }, "com.amazonaws.appsync#ResolverKind": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "UNIT", "name": "UNIT" }, { "value": "PIPELINE", "name": "PIPELINE" } ] } }, "com.amazonaws.appsync#Resolvers": { "type": "list", "member": { "target": "com.amazonaws.appsync#Resolver" } }, "com.amazonaws.appsync#ResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 70, "max": 75 }, "smithy.api#pattern": "^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\\d{12}:apis/[0-9A-Za-z_-]{26}$" } }, "com.amazonaws.appsync#ResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 65536 }, "smithy.api#pattern": "[_A-Za-z][_0-9A-Za-z]*" } }, "com.amazonaws.appsync#SchemaStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PROCESSING", "name": "Processing" }, { "value": "ACTIVE", "name": "Active" }, { "value": "DELETING", "name": "Deleting" }, { "value": "FAILED", "name": "Failed" }, { "value": "SUCCESS", "name": "Success" }, { "value": "NOT_APPLICABLE", "name": "NotApplicable" } ] } }, "com.amazonaws.appsync#StartSchemaCreation": { "type": "operation", "input": { "target": "com.amazonaws.appsync#StartSchemaCreationRequest" }, "output": { "target": "com.amazonaws.appsync#StartSchemaCreationResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Adds a new schema to your GraphQL API.
\nThis operation is asynchronous. Use to\n determine when it has completed.
", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/schemacreation", "code": 200 } } }, "com.amazonaws.appsync#StartSchemaCreationRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "definition": { "target": "com.amazonaws.appsync#Blob", "traits": { "smithy.api#documentation": "The schema definition, in GraphQL schema language format.
", "smithy.api#required": {} } } } }, "com.amazonaws.appsync#StartSchemaCreationResponse": { "type": "structure", "members": { "status": { "target": "com.amazonaws.appsync#SchemaStatus", "traits": { "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When\n the schema is in the ACTIVE state, you can add data.
" } } } }, "com.amazonaws.appsync#String": { "type": "string" }, "com.amazonaws.appsync#SyncConfig": { "type": "structure", "members": { "conflictHandler": { "target": "com.amazonaws.appsync#ConflictHandlerType", "traits": { "smithy.api#documentation": "The Conflict Resolution strategy to perform in the event of a conflict.
\n\n OPTIMISTIC_CONCURRENCY: Resolve conflicts by\n rejecting mutations when versions do not match the latest version at the\n server.
\n\n AUTOMERGE: Resolve conflicts with the\n Automerge conflict resolution strategy.
\n\n LAMBDA: Resolve conflicts with a Lambda\n function supplied in the LambdaConflictHandlerConfig.
\nThe Conflict Detection strategy to use.
\n\n VERSION: Detect conflicts based on object\n versions for this resolver.
\n\n NONE: Do not detect conflicts when executing\n this resolver.
\nThe LambdaConflictHandlerConfig
when configuring LAMBDA as the Conflict\n Handler.
Describes a Sync configuration for a resolver.
\nContains information on which Conflict Detection as well as Resolution strategy should\n be performed when the resolver is invoked.
" } }, "com.amazonaws.appsync#TagKey": { "type": "string", "traits": { "smithy.api#documentation": "The key for the tag.
", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, "com.amazonaws.appsync#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.appsync#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.appsync#TagMap": { "type": "map", "key": { "target": "com.amazonaws.appsync#TagKey" }, "value": { "target": "com.amazonaws.appsync#TagValue" }, "traits": { "smithy.api#documentation": "A map with keys of TagKey
objects and values of TagValue
\n objects.
Tags a resource with user-supplied tags.
", "smithy.api#http": { "method": "POST", "uri": "/v1/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.appsync#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.appsync#ResourceArn", "traits": { "smithy.api#documentation": "The GraphqlApi
ARN.
A TagMap
object.
The value for the tag.
", "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.appsync#Type": { "type": "structure", "members": { "name": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The type name.
" } }, "description": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The type description.
" } }, "arn": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The type ARN.
" } }, "definition": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The type definition.
" } }, "format": { "target": "com.amazonaws.appsync#TypeDefinitionFormat", "traits": { "smithy.api#documentation": "The type format: SDL or JSON.
" } } }, "traits": { "smithy.api#documentation": "Describes a type.
" } }, "com.amazonaws.appsync#TypeDefinitionFormat": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SDL", "name": "SDL" }, { "value": "JSON", "name": "JSON" } ] } }, "com.amazonaws.appsync#TypeList": { "type": "list", "member": { "target": "com.amazonaws.appsync#Type" } }, "com.amazonaws.appsync#UnauthorizedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.appsync#String" } }, "traits": { "smithy.api#documentation": "You are not authorized to perform this operation.
", "smithy.api#error": "client", "smithy.api#httpError": 401 } }, "com.amazonaws.appsync#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.appsync#UntagResourceRequest" }, "output": { "target": "com.amazonaws.appsync#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.appsync#AccessDeniedException" }, { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#LimitExceededException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Untags a resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/v1/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.appsync#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.appsync#ResourceArn", "traits": { "smithy.api#documentation": "The GraphqlApi
ARN.
A list of TagKey
objects.
Updates the cache for the GraphQL API.
", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/ApiCaches/update", "code": 200 } } }, "com.amazonaws.appsync#UpdateApiCacheRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The GraphQL API Id.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ttl": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "TTL in seconds for cache entries.
\nValid values are between 1 and 3600 seconds.
", "smithy.api#required": {} } }, "apiCachingBehavior": { "target": "com.amazonaws.appsync#ApiCachingBehavior", "traits": { "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully\n cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers\n that you specify are cached.
\nThe cache instance type. Valid values are
\n\n SMALL
\n
\n MEDIUM
\n
\n LARGE
\n
\n XLARGE
\n
\n LARGE_2X
\n
\n LARGE_4X
\n
\n LARGE_8X
(not available in all regions)
\n LARGE_12X
\n
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.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nRepresents the input of a UpdateApiCache
operation.
The ApiCache
object.
Represents the output of a UpdateApiCache
operation.
Updates an API key. The key can be updated while it is not deleted.
", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/apikeys/{id}", "code": 200 } } }, "com.amazonaws.appsync#UpdateApiKeyRequest": { "type": "structure", "members": { "apiId": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The ID for the GraphQL API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The API key ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "A description of the purpose of the API key.
" } }, "expires": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#documentation": "The time from update time after which the API key expires. The date is represented as\n seconds since the epoch. For more information, see .
" } } } }, "com.amazonaws.appsync#UpdateApiKeyResponse": { "type": "structure", "members": { "apiKey": { "target": "com.amazonaws.appsync#ApiKey", "traits": { "smithy.api#documentation": "The API key.
" } } } }, "com.amazonaws.appsync#UpdateDataSource": { "type": "operation", "input": { "target": "com.amazonaws.appsync#UpdateDataSourceRequest" }, "output": { "target": "com.amazonaws.appsync#UpdateDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.appsync#BadRequestException" }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, { "target": "com.amazonaws.appsync#InternalFailureException" }, { "target": "com.amazonaws.appsync#NotFoundException" }, { "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates a DataSource
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The new name for the data source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The new description for the data source.
" } }, "type": { "target": "com.amazonaws.appsync#DataSourceType", "traits": { "smithy.api#documentation": "The new data source type.
", "smithy.api#required": {} } }, "serviceRoleArn": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The new service role ARN for the data source.
" } }, "dynamodbConfig": { "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", "traits": { "smithy.api#documentation": "The new Amazon DynamoDB configuration.
" } }, "lambdaConfig": { "target": "com.amazonaws.appsync#LambdaDataSourceConfig", "traits": { "smithy.api#documentation": "The new AWS Lambda configuration.
" } }, "elasticsearchConfig": { "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", "traits": { "smithy.api#documentation": "The new Elasticsearch Service configuration.
" } }, "httpConfig": { "target": "com.amazonaws.appsync#HttpDataSourceConfig", "traits": { "smithy.api#documentation": "The new HTTP endpoint configuration.
" } }, "relationalDatabaseConfig": { "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", "traits": { "smithy.api#documentation": "The new relational database configuration.
" } } } }, "com.amazonaws.appsync#UpdateDataSourceResponse": { "type": "structure", "members": { "dataSource": { "target": "com.amazonaws.appsync#DataSource", "traits": { "smithy.api#documentation": "The updated DataSource
object.
Updates a Function
object.
The GraphQL API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The Function
name.
The Function
description.
The function ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "dataSourceName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The Function
\n DataSource
name.
The Function
request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.
The Function
request mapping template.
The version
of the request mapping template. Currently the supported value\n is 2018-05-29.
The Function
object.
Updates a GraphqlApi
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The new name for the GraphqlApi
object.
The Amazon CloudWatch Logs configuration for the GraphqlApi
object.
The new authentication type for the GraphqlApi
object.
The new Amazon Cognito user pool configuration for the GraphqlApi
\n object.
The OpenID Connect configuration for the GraphqlApi
object.
A list of additional authentication providers for the GraphqlApi
\n API.
A flag indicating whether to enable X-Ray tracing for the\n GraphqlApi
.
The updated GraphqlApi
object.
Updates a Resolver
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "typeName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The new type name.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fieldName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The new field name.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "dataSourceName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The new data source name.
" } }, "requestMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { "smithy.api#documentation": "The new request mapping template.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).
\nVTL request mapping templates are optional when using a Lambda data source. For all\n other data sources, VTL request and response mapping templates are required.
" } }, "responseMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { "smithy.api#documentation": "The new response mapping template.
" } }, "kind": { "target": "com.amazonaws.appsync#ResolverKind", "traits": { "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. A UNIT resolver enables you to execute a GraphQL query\n against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. A PIPELINE\n resolver enables you to execute a series of Function
in a serial manner.\n You can use a pipeline resolver to execute a GraphQL query against multiple data\n sources.
The PipelineConfig
.
The SyncConfig
for a resolver attached to a versioned datasource.
The caching configuration for the resolver.
" } } } }, "com.amazonaws.appsync#UpdateResolverResponse": { "type": "structure", "members": { "resolver": { "target": "com.amazonaws.appsync#Resolver", "traits": { "smithy.api#documentation": "The updated Resolver
object.
Updates a Type
object.
The API ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "typeName": { "target": "com.amazonaws.appsync#ResourceName", "traits": { "smithy.api#documentation": "The new type name.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "definition": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The new definition.
" } }, "format": { "target": "com.amazonaws.appsync#TypeDefinitionFormat", "traits": { "smithy.api#documentation": "The new type format: SDL or JSON.
", "smithy.api#required": {} } } } }, "com.amazonaws.appsync#UpdateTypeResponse": { "type": "structure", "members": { "type": { "target": "com.amazonaws.appsync#Type", "traits": { "smithy.api#documentation": "The updated Type
object.
The user pool ID.
", "smithy.api#required": {} } }, "awsRegion": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "The AWS Region in which the user pool was created.
", "smithy.api#required": {} } }, "defaultAction": { "target": "com.amazonaws.appsync#DefaultAction", "traits": { "smithy.api#documentation": "The action that you want your GraphQL API to take when a request that uses Amazon\n Cognito user pool authentication doesn't match the Amazon Cognito user pool\n configuration.
", "smithy.api#required": {} } }, "appIdClientRegex": { "target": "com.amazonaws.appsync#String", "traits": { "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client\n ID.
" } } }, "traits": { "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" } } } }