1{ 2 "version": "2.0", 3 "service": "<p>AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.</p>", 4 "operations": { 5 "CreateApiCache": "<p>Creates a cache for the GraphQL API.</p>", 6 "CreateApiKey": "<p>Creates a unique key that you can distribute to clients who are executing your API.</p>", 7 "CreateDataSource": "<p>Creates a <code>DataSource</code> object.</p>", 8 "CreateFunction": "<p>Creates a <code>Function</code> object.</p> <p>A function is a reusable entity. Multiple functions can be used to compose the resolver logic.</p>", 9 "CreateGraphqlApi": "<p>Creates a <code>GraphqlApi</code> object.</p>", 10 "CreateResolver": "<p>Creates a <code>Resolver</code> object.</p> <p>A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.</p>", 11 "CreateType": "<p>Creates a <code>Type</code> object.</p>", 12 "DeleteApiCache": "<p>Deletes an <code>ApiCache</code> object.</p>", 13 "DeleteApiKey": "<p>Deletes an API key.</p>", 14 "DeleteDataSource": "<p>Deletes a <code>DataSource</code> object.</p>", 15 "DeleteFunction": "<p>Deletes a <code>Function</code>.</p>", 16 "DeleteGraphqlApi": "<p>Deletes a <code>GraphqlApi</code> object.</p>", 17 "DeleteResolver": "<p>Deletes a <code>Resolver</code> object.</p>", 18 "DeleteType": "<p>Deletes a <code>Type</code> object.</p>", 19 "FlushApiCache": "<p>Flushes an <code>ApiCache</code> object.</p>", 20 "GetApiCache": "<p>Retrieves an <code>ApiCache</code> object.</p>", 21 "GetDataSource": "<p>Retrieves a <code>DataSource</code> object.</p>", 22 "GetFunction": "<p>Get a <code>Function</code>.</p>", 23 "GetGraphqlApi": "<p>Retrieves a <code>GraphqlApi</code> object.</p>", 24 "GetIntrospectionSchema": "<p>Retrieves the introspection schema for a GraphQL API.</p>", 25 "GetResolver": "<p>Retrieves a <code>Resolver</code> object.</p>", 26 "GetSchemaCreationStatus": "<p>Retrieves the current status of a schema creation operation.</p>", 27 "GetType": "<p>Retrieves a <code>Type</code> object.</p>", 28 "ListApiKeys": "<p>Lists the API keys for a given API.</p> <note> <p>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 <code>DeleteApiKey</code> to manually delete a key before it's automatically deleted.</p> </note>", 29 "ListDataSources": "<p>Lists the data sources for a given API.</p>", 30 "ListFunctions": "<p>List multiple functions.</p>", 31 "ListGraphqlApis": "<p>Lists your GraphQL APIs.</p>", 32 "ListResolvers": "<p>Lists the resolvers for a given API and type.</p>", 33 "ListResolversByFunction": "<p>List the resolvers that are associated with a specific function.</p>", 34 "ListTagsForResource": "<p>Lists the tags for a resource.</p>", 35 "ListTypes": "<p>Lists the types for a given API.</p>", 36 "StartSchemaCreation": "<p>Adds a new schema to your GraphQL API.</p> <p>This operation is asynchronous. Use to determine when it has completed.</p>", 37 "TagResource": "<p>Tags a resource with user-supplied tags.</p>", 38 "UntagResource": "<p>Untags a resource.</p>", 39 "UpdateApiCache": "<p>Updates the cache for the GraphQL API.</p>", 40 "UpdateApiKey": "<p>Updates an API key. The key can be updated while it is not deleted.</p>", 41 "UpdateDataSource": "<p>Updates a <code>DataSource</code> object.</p>", 42 "UpdateFunction": "<p>Updates a <code>Function</code> object.</p>", 43 "UpdateGraphqlApi": "<p>Updates a <code>GraphqlApi</code> object.</p>", 44 "UpdateResolver": "<p>Updates a <code>Resolver</code> object.</p>", 45 "UpdateType": "<p>Updates a <code>Type</code> object.</p>" 46 }, 47 "shapes": { 48 "AccessDeniedException": { 49 "base": "<p>You do not have access to perform this operation on this resource.</p>", 50 "refs": { 51 } 52 }, 53 "AdditionalAuthenticationProvider": { 54 "base": "<p>Describes an additional authentication provider.</p>", 55 "refs": { 56 "AdditionalAuthenticationProviders$member": null 57 } 58 }, 59 "AdditionalAuthenticationProviders": { 60 "base": null, 61 "refs": { 62 "CreateGraphqlApiRequest$additionalAuthenticationProviders": "<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>", 63 "GraphqlApi$additionalAuthenticationProviders": "<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>", 64 "UpdateGraphqlApiRequest$additionalAuthenticationProviders": "<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>" 65 } 66 }, 67 "ApiCache": { 68 "base": "<p>The <code>ApiCache</code> object.</p>", 69 "refs": { 70 "CreateApiCacheResponse$apiCache": "<p>The <code>ApiCache</code> object.</p>", 71 "GetApiCacheResponse$apiCache": "<p>The <code>ApiCache</code> object.</p>", 72 "UpdateApiCacheResponse$apiCache": "<p>The <code>ApiCache</code> object.</p>" 73 } 74 }, 75 "ApiCacheStatus": { 76 "base": null, 77 "refs": { 78 "ApiCache$status": "<p>The cache instance status.</p> <ul> <li> <p> <b>AVAILABLE</b>: The instance is available for use.</p> </li> <li> <p> <b>CREATING</b>: The instance is currently creating.</p> </li> <li> <p> <b>DELETING</b>: The instance is currently deleting.</p> </li> <li> <p> <b>MODIFYING</b>: The instance is currently modifying.</p> </li> <li> <p> <b>FAILED</b>: The instance has failed creation.</p> </li> </ul>" 79 } 80 }, 81 "ApiCacheType": { 82 "base": null, 83 "refs": { 84 "ApiCache$type": "<p>The cache instance type. Valid values are </p> <ul> <li> <p> <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p> <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p> <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li> <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p> <code>LARGE_12X</code> </p> </li> </ul> <p>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.</p> <p>The following legacy instance types are available, but their use is discouraged:</p> <ul> <li> <p> <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>: A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p> </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p> <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>", 85 "CreateApiCacheRequest$type": "<p>The cache instance type. Valid values are </p> <ul> <li> <p> <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p> <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p> <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li> <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p> <code>LARGE_12X</code> </p> </li> </ul> <p>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.</p> <p>The following legacy instance types are available, but their use is discouraged:</p> <ul> <li> <p> <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>: A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p> </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p> <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>", 86 "UpdateApiCacheRequest$type": "<p>The cache instance type. Valid values are </p> <ul> <li> <p> <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p> <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p> <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li> <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p> <code>LARGE_12X</code> </p> </li> </ul> <p>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.</p> <p>The following legacy instance types are available, but their use is discouraged:</p> <ul> <li> <p> <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>: A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p> </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p> <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>" 87 } 88 }, 89 "ApiCachingBehavior": { 90 "base": null, 91 "refs": { 92 "ApiCache$apiCachingBehavior": "<p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are cached.</p> </li> </ul>", 93 "CreateApiCacheRequest$apiCachingBehavior": "<p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are cached.</p> </li> </ul>", 94 "UpdateApiCacheRequest$apiCachingBehavior": "<p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are cached.</p> </li> </ul>" 95 } 96 }, 97 "ApiKey": { 98 "base": "<p>Describes an API key.</p> <p>Customers invoke AWS AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:</p> <p> <b>da1</b>: 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.</p> <ul> <li> <p> <code>ListApiKeys</code> returns the expiration time in milliseconds.</p> </li> <li> <p> <code>CreateApiKey</code> returns the expiration time in milliseconds.</p> </li> <li> <p> <code>UpdateApiKey</code> is not available for this key version.</p> </li> <li> <p> <code>DeleteApiKey</code> deletes the item from the table.</p> </li> <li> <p>Expiration is stored in Amazon DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we will delete these keys from the table after February 21, 2018.</p> </li> </ul> <p> <b>da2</b>: This version was introduced in February 2018 when AppSync added support to extend key expiration.</p> <ul> <li> <p> <code>ListApiKeys</code> returns the expiration time and deletion time in seconds.</p> </li> <li> <p> <code>CreateApiKey</code> returns the expiration time and deletion time in seconds and accepts a user-provided expiration time in seconds.</p> </li> <li> <p> <code>UpdateApiKey</code> returns the expiration time and and deletion time in seconds and accepts a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration time. Key expiration time can be updated while the key is not deleted. </p> </li> <li> <p> <code>DeleteApiKey</code> deletes the item from the table.</p> </li> <li> <p>Expiration is stored in Amazon DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. But the key can be reinstated before deletion.</p> </li> <li> <p>Deletion is stored in Amazon DynamoDB as seconds. The key will be deleted after deletion time. </p> </li> </ul>", 99 "refs": { 100 "ApiKeys$member": null, 101 "CreateApiKeyResponse$apiKey": "<p>The API key.</p>", 102 "UpdateApiKeyResponse$apiKey": "<p>The API key.</p>" 103 } 104 }, 105 "ApiKeyLimitExceededException": { 106 "base": "<p>The API key exceeded a limit. Try your request again.</p>", 107 "refs": { 108 } 109 }, 110 "ApiKeyValidityOutOfBoundsException": { 111 "base": "<p>The API key expiration must be set to a value between 1 and 365 days from creation (for <code>CreateApiKey</code>) or from update (for <code>UpdateApiKey</code>).</p>", 112 "refs": { 113 } 114 }, 115 "ApiKeys": { 116 "base": null, 117 "refs": { 118 "ListApiKeysResponse$apiKeys": "<p>The <code>ApiKey</code> objects.</p>" 119 } 120 }, 121 "ApiLimitExceededException": { 122 "base": "<p>The GraphQL API exceeded a limit. Try your request again.</p>", 123 "refs": { 124 } 125 }, 126 "AuthenticationType": { 127 "base": null, 128 "refs": { 129 "AdditionalAuthenticationProvider$authenticationType": "<p>The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.</p>", 130 "CreateGraphqlApiRequest$authenticationType": "<p>The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.</p>", 131 "GraphqlApi$authenticationType": "<p>The authentication type.</p>", 132 "UpdateGraphqlApiRequest$authenticationType": "<p>The new authentication type for the <code>GraphqlApi</code> object.</p>" 133 } 134 }, 135 "AuthorizationConfig": { 136 "base": "<p>The authorization config in case the HTTP endpoint requires authorization.</p>", 137 "refs": { 138 "HttpDataSourceConfig$authorizationConfig": "<p>The authorization config in case the HTTP endpoint requires authorization.</p>" 139 } 140 }, 141 "AuthorizationType": { 142 "base": null, 143 "refs": { 144 "AuthorizationConfig$authorizationType": "<p>The authorization type required by the HTTP endpoint.</p> <ul> <li> <p> <b>AWS_IAM</b>: The authorization type is Sigv4.</p> </li> </ul>" 145 } 146 }, 147 "AwsIamConfig": { 148 "base": "<p>The AWS IAM configuration.</p>", 149 "refs": { 150 "AuthorizationConfig$awsIamConfig": "<p>The AWS IAM settings.</p>" 151 } 152 }, 153 "BadRequestException": { 154 "base": "<p>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. </p>", 155 "refs": { 156 } 157 }, 158 "Blob": { 159 "base": null, 160 "refs": { 161 "GetIntrospectionSchemaResponse$schema": "<p>The schema, in GraphQL Schema Definition Language (SDL) format.</p> <p>For more information, see the <a href=\"http://graphql.org/learn/schema/\">GraphQL SDL documentation</a>.</p>", 162 "StartSchemaCreationRequest$definition": "<p>The schema definition, in GraphQL schema language format.</p>" 163 } 164 }, 165 "Boolean": { 166 "base": null, 167 "refs": { 168 "ApiCache$transitEncryptionEnabled": "<p>Transit encryption flag when connecting to cache. This setting cannot be updated after creation.</p>", 169 "ApiCache$atRestEncryptionEnabled": "<p>At rest encryption flag for cache. This setting cannot be updated after creation.</p>", 170 "CreateApiCacheRequest$transitEncryptionEnabled": "<p>Transit encryption flag when connecting to cache. This setting cannot be updated after creation.</p>", 171 "CreateApiCacheRequest$atRestEncryptionEnabled": "<p>At rest encryption flag for cache. This setting cannot be updated after creation.</p>", 172 "CreateGraphqlApiRequest$xrayEnabled": "<p>A flag indicating whether to enable X-Ray tracing for the <code>GraphqlApi</code>.</p>", 173 "DynamodbDataSourceConfig$useCallerCredentials": "<p>Set to TRUE to use Amazon Cognito credentials with this data source.</p>", 174 "DynamodbDataSourceConfig$versioned": "<p>Set to TRUE to use Conflict Detection and Resolution with this data source.</p>", 175 "GraphqlApi$xrayEnabled": "<p>A flag representing whether X-Ray tracing is enabled for this <code>GraphqlApi</code>.</p>", 176 "LogConfig$excludeVerboseContent": "<p>Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.</p>", 177 "UpdateGraphqlApiRequest$xrayEnabled": "<p>A flag indicating whether to enable X-Ray tracing for the <code>GraphqlApi</code>.</p>" 178 } 179 }, 180 "BooleanValue": { 181 "base": null, 182 "refs": { 183 "GetIntrospectionSchemaRequest$includeDirectives": "<p>A flag that specifies whether the schema introspection should contain directives.</p>" 184 } 185 }, 186 "CachingConfig": { 187 "base": "<p>The caching configuration for a resolver that has caching enabled.</p>", 188 "refs": { 189 "CreateResolverRequest$cachingConfig": "<p>The caching configuration for the resolver.</p>", 190 "Resolver$cachingConfig": "<p>The caching configuration for the resolver.</p>", 191 "UpdateResolverRequest$cachingConfig": "<p>The caching configuration for the resolver.</p>" 192 } 193 }, 194 "CachingKeys": { 195 "base": null, 196 "refs": { 197 "CachingConfig$cachingKeys": "<p>The caching keys for a resolver that has caching enabled.</p> <p>Valid values are entries from the <code>$context.arguments</code>, <code>$context.source</code>, and <code>$context.identity</code> maps.</p>" 198 } 199 }, 200 "CognitoUserPoolConfig": { 201 "base": "<p>Describes an Amazon Cognito user pool configuration.</p>", 202 "refs": { 203 "AdditionalAuthenticationProvider$userPoolConfig": "<p>The Amazon Cognito user pool configuration.</p>" 204 } 205 }, 206 "ConcurrentModificationException": { 207 "base": "<p>Another modification is in progress at this time and it must complete before you can make your change. </p>", 208 "refs": { 209 } 210 }, 211 "ConflictDetectionType": { 212 "base": null, 213 "refs": { 214 "SyncConfig$conflictDetection": "<p>The Conflict Detection strategy to use.</p> <ul> <li> <p> <b>VERSION</b>: Detect conflicts based on object versions for this resolver.</p> </li> <li> <p> <b>NONE</b>: Do not detect conflicts when executing this resolver.</p> </li> </ul>" 215 } 216 }, 217 "ConflictHandlerType": { 218 "base": null, 219 "refs": { 220 "SyncConfig$conflictHandler": "<p>The Conflict Resolution strategy to perform in the event of a conflict.</p> <ul> <li> <p> <b>OPTIMISTIC_CONCURRENCY</b>: Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.</p> </li> <li> <p> <b>AUTOMERGE</b>: Resolve conflicts with the Automerge conflict resolution strategy.</p> </li> <li> <p> <b>LAMBDA</b>: Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.</p> </li> </ul>" 221 } 222 }, 223 "CreateApiCacheRequest": { 224 "base": "<p>Represents the input of a <code>CreateApiCache</code> operation.</p>", 225 "refs": { 226 } 227 }, 228 "CreateApiCacheResponse": { 229 "base": "<p>Represents the output of a <code>CreateApiCache</code> operation.</p>", 230 "refs": { 231 } 232 }, 233 "CreateApiKeyRequest": { 234 "base": null, 235 "refs": { 236 } 237 }, 238 "CreateApiKeyResponse": { 239 "base": null, 240 "refs": { 241 } 242 }, 243 "CreateDataSourceRequest": { 244 "base": null, 245 "refs": { 246 } 247 }, 248 "CreateDataSourceResponse": { 249 "base": null, 250 "refs": { 251 } 252 }, 253 "CreateFunctionRequest": { 254 "base": null, 255 "refs": { 256 } 257 }, 258 "CreateFunctionResponse": { 259 "base": null, 260 "refs": { 261 } 262 }, 263 "CreateGraphqlApiRequest": { 264 "base": null, 265 "refs": { 266 } 267 }, 268 "CreateGraphqlApiResponse": { 269 "base": null, 270 "refs": { 271 } 272 }, 273 "CreateResolverRequest": { 274 "base": null, 275 "refs": { 276 } 277 }, 278 "CreateResolverResponse": { 279 "base": null, 280 "refs": { 281 } 282 }, 283 "CreateTypeRequest": { 284 "base": null, 285 "refs": { 286 } 287 }, 288 "CreateTypeResponse": { 289 "base": null, 290 "refs": { 291 } 292 }, 293 "DataSource": { 294 "base": "<p>Describes a data source.</p>", 295 "refs": { 296 "CreateDataSourceResponse$dataSource": "<p>The <code>DataSource</code> object.</p>", 297 "DataSources$member": null, 298 "GetDataSourceResponse$dataSource": "<p>The <code>DataSource</code> object.</p>", 299 "UpdateDataSourceResponse$dataSource": "<p>The updated <code>DataSource</code> object.</p>" 300 } 301 }, 302 "DataSourceType": { 303 "base": null, 304 "refs": { 305 "CreateDataSourceRequest$type": "<p>The type of the <code>DataSource</code>.</p>", 306 "DataSource$type": "<p>The type of the data source.</p> <ul> <li> <p> <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p> </li> <li> <p> <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon Elasticsearch Service domain.</p> </li> <li> <p> <b>AWS_LAMBDA</b>: The data source is an AWS Lambda function.</p> </li> <li> <p> <b>NONE</b>: There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.</p> </li> <li> <p> <b>HTTP</b>: The data source is an HTTP endpoint.</p> </li> <li> <p> <b>RELATIONAL_DATABASE</b>: The data source is a relational database.</p> </li> </ul>", 307 "UpdateDataSourceRequest$type": "<p>The new data source type.</p>" 308 } 309 }, 310 "DataSources": { 311 "base": null, 312 "refs": { 313 "ListDataSourcesResponse$dataSources": "<p>The <code>DataSource</code> objects.</p>" 314 } 315 }, 316 "DefaultAction": { 317 "base": null, 318 "refs": { 319 "UserPoolConfig$defaultAction": "<p>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.</p>" 320 } 321 }, 322 "DeleteApiCacheRequest": { 323 "base": "<p>Represents the input of a <code>DeleteApiCache</code> operation.</p>", 324 "refs": { 325 } 326 }, 327 "DeleteApiCacheResponse": { 328 "base": "<p>Represents the output of a <code>DeleteApiCache</code> operation.</p>", 329 "refs": { 330 } 331 }, 332 "DeleteApiKeyRequest": { 333 "base": null, 334 "refs": { 335 } 336 }, 337 "DeleteApiKeyResponse": { 338 "base": null, 339 "refs": { 340 } 341 }, 342 "DeleteDataSourceRequest": { 343 "base": null, 344 "refs": { 345 } 346 }, 347 "DeleteDataSourceResponse": { 348 "base": null, 349 "refs": { 350 } 351 }, 352 "DeleteFunctionRequest": { 353 "base": null, 354 "refs": { 355 } 356 }, 357 "DeleteFunctionResponse": { 358 "base": null, 359 "refs": { 360 } 361 }, 362 "DeleteGraphqlApiRequest": { 363 "base": null, 364 "refs": { 365 } 366 }, 367 "DeleteGraphqlApiResponse": { 368 "base": null, 369 "refs": { 370 } 371 }, 372 "DeleteResolverRequest": { 373 "base": null, 374 "refs": { 375 } 376 }, 377 "DeleteResolverResponse": { 378 "base": null, 379 "refs": { 380 } 381 }, 382 "DeleteTypeRequest": { 383 "base": null, 384 "refs": { 385 } 386 }, 387 "DeleteTypeResponse": { 388 "base": null, 389 "refs": { 390 } 391 }, 392 "DeltaSyncConfig": { 393 "base": "<p>Describes a Delta Sync configuration.</p>", 394 "refs": { 395 "DynamodbDataSourceConfig$deltaSyncConfig": "<p>The <code>DeltaSyncConfig</code> for a versioned datasource.</p>" 396 } 397 }, 398 "DynamodbDataSourceConfig": { 399 "base": "<p>Describes an Amazon DynamoDB data source configuration.</p>", 400 "refs": { 401 "CreateDataSourceRequest$dynamodbConfig": "<p>Amazon DynamoDB settings.</p>", 402 "DataSource$dynamodbConfig": "<p>Amazon DynamoDB settings.</p>", 403 "UpdateDataSourceRequest$dynamodbConfig": "<p>The new Amazon DynamoDB configuration.</p>" 404 } 405 }, 406 "ElasticsearchDataSourceConfig": { 407 "base": "<p>Describes an Elasticsearch data source configuration.</p>", 408 "refs": { 409 "CreateDataSourceRequest$elasticsearchConfig": "<p>Amazon Elasticsearch Service settings.</p>", 410 "DataSource$elasticsearchConfig": "<p>Amazon Elasticsearch Service settings.</p>", 411 "UpdateDataSourceRequest$elasticsearchConfig": "<p>The new Elasticsearch Service configuration.</p>" 412 } 413 }, 414 "ErrorMessage": { 415 "base": null, 416 "refs": { 417 "BadRequestException$message": null, 418 "ConcurrentModificationException$message": null, 419 "GraphQLSchemaException$message": null 420 } 421 }, 422 "FieldLogLevel": { 423 "base": null, 424 "refs": { 425 "LogConfig$fieldLogLevel": "<p>The field logging level. Values can be NONE, ERROR, or ALL. </p> <ul> <li> <p> <b>NONE</b>: No field-level logs are captured.</p> </li> <li> <p> <b>ERROR</b>: Logs the following information only for the fields that are in error:</p> <ul> <li> <p>The error section in the server response.</p> </li> <li> <p>Field-level errors.</p> </li> <li> <p>The generated request/response functions that got resolved for error fields.</p> </li> </ul> </li> <li> <p> <b>ALL</b>: The following information is logged for all fields in the query:</p> <ul> <li> <p>Field-level tracing information.</p> </li> <li> <p>The generated request/response functions that got resolved for each field.</p> </li> </ul> </li> </ul>" 426 } 427 }, 428 "FlushApiCacheRequest": { 429 "base": "<p>Represents the input of a <code>FlushApiCache</code> operation.</p>", 430 "refs": { 431 } 432 }, 433 "FlushApiCacheResponse": { 434 "base": "<p>Represents the output of a <code>FlushApiCache</code> operation.</p>", 435 "refs": { 436 } 437 }, 438 "FunctionConfiguration": { 439 "base": "<p>A function is a reusable entity. Multiple functions can be used to compose the resolver logic.</p>", 440 "refs": { 441 "CreateFunctionResponse$functionConfiguration": "<p>The <code>Function</code> object.</p>", 442 "Functions$member": null, 443 "GetFunctionResponse$functionConfiguration": "<p>The <code>Function</code> object.</p>", 444 "UpdateFunctionResponse$functionConfiguration": "<p>The <code>Function</code> object.</p>" 445 } 446 }, 447 "Functions": { 448 "base": null, 449 "refs": { 450 "ListFunctionsResponse$functions": "<p>A list of <code>Function</code> objects.</p>" 451 } 452 }, 453 "FunctionsIds": { 454 "base": null, 455 "refs": { 456 "PipelineConfig$functions": "<p>A list of <code>Function</code> objects.</p>" 457 } 458 }, 459 "GetApiCacheRequest": { 460 "base": "<p>Represents the input of a <code>GetApiCache</code> operation.</p>", 461 "refs": { 462 } 463 }, 464 "GetApiCacheResponse": { 465 "base": "<p>Represents the output of a <code>GetApiCache</code> operation.</p>", 466 "refs": { 467 } 468 }, 469 "GetDataSourceRequest": { 470 "base": null, 471 "refs": { 472 } 473 }, 474 "GetDataSourceResponse": { 475 "base": null, 476 "refs": { 477 } 478 }, 479 "GetFunctionRequest": { 480 "base": null, 481 "refs": { 482 } 483 }, 484 "GetFunctionResponse": { 485 "base": null, 486 "refs": { 487 } 488 }, 489 "GetGraphqlApiRequest": { 490 "base": null, 491 "refs": { 492 } 493 }, 494 "GetGraphqlApiResponse": { 495 "base": null, 496 "refs": { 497 } 498 }, 499 "GetIntrospectionSchemaRequest": { 500 "base": null, 501 "refs": { 502 } 503 }, 504 "GetIntrospectionSchemaResponse": { 505 "base": null, 506 "refs": { 507 } 508 }, 509 "GetResolverRequest": { 510 "base": null, 511 "refs": { 512 } 513 }, 514 "GetResolverResponse": { 515 "base": null, 516 "refs": { 517 } 518 }, 519 "GetSchemaCreationStatusRequest": { 520 "base": null, 521 "refs": { 522 } 523 }, 524 "GetSchemaCreationStatusResponse": { 525 "base": null, 526 "refs": { 527 } 528 }, 529 "GetTypeRequest": { 530 "base": null, 531 "refs": { 532 } 533 }, 534 "GetTypeResponse": { 535 "base": null, 536 "refs": { 537 } 538 }, 539 "GraphQLSchemaException": { 540 "base": "<p>The GraphQL schema is not valid.</p>", 541 "refs": { 542 } 543 }, 544 "GraphqlApi": { 545 "base": "<p>Describes a GraphQL API.</p>", 546 "refs": { 547 "CreateGraphqlApiResponse$graphqlApi": "<p>The <code>GraphqlApi</code>.</p>", 548 "GetGraphqlApiResponse$graphqlApi": "<p>The <code>GraphqlApi</code> object.</p>", 549 "GraphqlApis$member": null, 550 "UpdateGraphqlApiResponse$graphqlApi": "<p>The updated <code>GraphqlApi</code> object.</p>" 551 } 552 }, 553 "GraphqlApis": { 554 "base": null, 555 "refs": { 556 "ListGraphqlApisResponse$graphqlApis": "<p>The <code>GraphqlApi</code> objects.</p>" 557 } 558 }, 559 "HttpDataSourceConfig": { 560 "base": "<p>Describes an HTTP data source configuration.</p>", 561 "refs": { 562 "CreateDataSourceRequest$httpConfig": "<p>HTTP endpoint settings.</p>", 563 "DataSource$httpConfig": "<p>HTTP endpoint settings.</p>", 564 "UpdateDataSourceRequest$httpConfig": "<p>The new HTTP endpoint configuration.</p>" 565 } 566 }, 567 "InternalFailureException": { 568 "base": "<p>An internal AWS AppSync error occurred. Try your request again.</p>", 569 "refs": { 570 } 571 }, 572 "LambdaConflictHandlerConfig": { 573 "base": "<p>The <code>LambdaConflictHandlerConfig</code> object when configuring LAMBDA as the Conflict Handler.</p>", 574 "refs": { 575 "SyncConfig$lambdaConflictHandlerConfig": "<p>The <code>LambdaConflictHandlerConfig</code> when configuring LAMBDA as the Conflict Handler.</p>" 576 } 577 }, 578 "LambdaDataSourceConfig": { 579 "base": "<p>Describes an AWS Lambda data source configuration.</p>", 580 "refs": { 581 "CreateDataSourceRequest$lambdaConfig": "<p>AWS Lambda settings.</p>", 582 "DataSource$lambdaConfig": "<p>AWS Lambda settings.</p>", 583 "UpdateDataSourceRequest$lambdaConfig": "<p>The new AWS Lambda configuration.</p>" 584 } 585 }, 586 "LimitExceededException": { 587 "base": "<p>The request exceeded a limit. Try your request again.</p>", 588 "refs": { 589 } 590 }, 591 "ListApiKeysRequest": { 592 "base": null, 593 "refs": { 594 } 595 }, 596 "ListApiKeysResponse": { 597 "base": null, 598 "refs": { 599 } 600 }, 601 "ListDataSourcesRequest": { 602 "base": null, 603 "refs": { 604 } 605 }, 606 "ListDataSourcesResponse": { 607 "base": null, 608 "refs": { 609 } 610 }, 611 "ListFunctionsRequest": { 612 "base": null, 613 "refs": { 614 } 615 }, 616 "ListFunctionsResponse": { 617 "base": null, 618 "refs": { 619 } 620 }, 621 "ListGraphqlApisRequest": { 622 "base": null, 623 "refs": { 624 } 625 }, 626 "ListGraphqlApisResponse": { 627 "base": null, 628 "refs": { 629 } 630 }, 631 "ListResolversByFunctionRequest": { 632 "base": null, 633 "refs": { 634 } 635 }, 636 "ListResolversByFunctionResponse": { 637 "base": null, 638 "refs": { 639 } 640 }, 641 "ListResolversRequest": { 642 "base": null, 643 "refs": { 644 } 645 }, 646 "ListResolversResponse": { 647 "base": null, 648 "refs": { 649 } 650 }, 651 "ListTagsForResourceRequest": { 652 "base": null, 653 "refs": { 654 } 655 }, 656 "ListTagsForResourceResponse": { 657 "base": null, 658 "refs": { 659 } 660 }, 661 "ListTypesRequest": { 662 "base": null, 663 "refs": { 664 } 665 }, 666 "ListTypesResponse": { 667 "base": null, 668 "refs": { 669 } 670 }, 671 "LogConfig": { 672 "base": "<p>The CloudWatch Logs configuration.</p>", 673 "refs": { 674 "CreateGraphqlApiRequest$logConfig": "<p>The Amazon CloudWatch Logs configuration.</p>", 675 "GraphqlApi$logConfig": "<p>The Amazon CloudWatch Logs configuration.</p>", 676 "UpdateGraphqlApiRequest$logConfig": "<p>The Amazon CloudWatch Logs configuration for the <code>GraphqlApi</code> object.</p>" 677 } 678 }, 679 "Long": { 680 "base": null, 681 "refs": { 682 "ApiCache$ttl": "<p>TTL in seconds for cache entries.</p> <p>Valid values are between 1 and 3600 seconds.</p>", 683 "ApiKey$expires": "<p>The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.</p>", 684 "ApiKey$deletes": "<p>The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.</p>", 685 "CachingConfig$ttl": "<p>The TTL in seconds for a resolver that has caching enabled.</p> <p>Valid values are between 1 and 3600 seconds.</p>", 686 "CreateApiCacheRequest$ttl": "<p>TTL in seconds for cache entries.</p> <p>Valid values are between 1 and 3600 seconds.</p>", 687 "CreateApiKeyRequest$expires": "<p>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 .</p>", 688 "DeltaSyncConfig$baseTableTTL": "<p>The number of minutes an Item is stored in the datasource.</p>", 689 "DeltaSyncConfig$deltaSyncTableTTL": "<p>The number of minutes a Delta Sync log entry is stored in the Delta Sync table.</p>", 690 "OpenIDConnectConfig$iatTTL": "<p>The number of milliseconds a token is valid after being issued to a user.</p>", 691 "OpenIDConnectConfig$authTTL": "<p>The number of milliseconds a token is valid after being authenticated.</p>", 692 "UpdateApiCacheRequest$ttl": "<p>TTL in seconds for cache entries.</p> <p>Valid values are between 1 and 3600 seconds.</p>", 693 "UpdateApiKeyRequest$expires": "<p>The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .</p>" 694 } 695 }, 696 "MapOfStringToString": { 697 "base": null, 698 "refs": { 699 "GraphqlApi$uris": "<p>The URIs.</p>" 700 } 701 }, 702 "MappingTemplate": { 703 "base": null, 704 "refs": { 705 "CreateFunctionRequest$requestMappingTemplate": "<p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the request mapping template.</p>", 706 "CreateFunctionRequest$responseMappingTemplate": "<p>The <code>Function</code> response mapping template. </p>", 707 "CreateResolverRequest$requestMappingTemplate": "<p>The mapping template to be used for requests.</p> <p>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).</p> <p>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.</p>", 708 "CreateResolverRequest$responseMappingTemplate": "<p>The mapping template to be used for responses from the data source.</p>", 709 "FunctionConfiguration$requestMappingTemplate": "<p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the request mapping template.</p>", 710 "FunctionConfiguration$responseMappingTemplate": "<p>The <code>Function</code> response mapping template.</p>", 711 "Resolver$requestMappingTemplate": "<p>The request mapping template.</p>", 712 "Resolver$responseMappingTemplate": "<p>The response mapping template.</p>", 713 "UpdateFunctionRequest$requestMappingTemplate": "<p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the request mapping template.</p>", 714 "UpdateFunctionRequest$responseMappingTemplate": "<p>The <code>Function</code> request mapping template. </p>", 715 "UpdateResolverRequest$requestMappingTemplate": "<p>The new request mapping template.</p> <p>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).</p> <p>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.</p>", 716 "UpdateResolverRequest$responseMappingTemplate": "<p>The new response mapping template.</p>" 717 } 718 }, 719 "MaxResults": { 720 "base": null, 721 "refs": { 722 "ListApiKeysRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>", 723 "ListDataSourcesRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>", 724 "ListFunctionsRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>", 725 "ListGraphqlApisRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>", 726 "ListResolversByFunctionRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>", 727 "ListResolversRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>", 728 "ListTypesRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>" 729 } 730 }, 731 "NotFoundException": { 732 "base": "<p>The resource specified in the request was not found. Check the resource, and then try again.</p>", 733 "refs": { 734 } 735 }, 736 "OpenIDConnectConfig": { 737 "base": "<p>Describes an OpenID Connect configuration.</p>", 738 "refs": { 739 "AdditionalAuthenticationProvider$openIDConnectConfig": "<p>The OpenID Connect configuration.</p>", 740 "CreateGraphqlApiRequest$openIDConnectConfig": "<p>The OpenID Connect configuration.</p>", 741 "GraphqlApi$openIDConnectConfig": "<p>The OpenID Connect configuration.</p>", 742 "UpdateGraphqlApiRequest$openIDConnectConfig": "<p>The OpenID Connect configuration for the <code>GraphqlApi</code> object.</p>" 743 } 744 }, 745 "OutputType": { 746 "base": null, 747 "refs": { 748 "GetIntrospectionSchemaRequest$format": "<p>The schema format: SDL or JSON.</p>" 749 } 750 }, 751 "PaginationToken": { 752 "base": null, 753 "refs": { 754 "ListApiKeysRequest$nextToken": "<p>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.</p>", 755 "ListApiKeysResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>", 756 "ListDataSourcesRequest$nextToken": "<p>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. </p>", 757 "ListDataSourcesResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>", 758 "ListFunctionsRequest$nextToken": "<p>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.</p>", 759 "ListFunctionsResponse$nextToken": "<p>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.</p>", 760 "ListGraphqlApisRequest$nextToken": "<p>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. </p>", 761 "ListGraphqlApisResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>", 762 "ListResolversByFunctionRequest$nextToken": "<p>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.</p>", 763 "ListResolversByFunctionResponse$nextToken": "<p>An identifier that can be used to return the next set of items in the list.</p>", 764 "ListResolversRequest$nextToken": "<p>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. </p>", 765 "ListResolversResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>", 766 "ListTypesRequest$nextToken": "<p>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. </p>", 767 "ListTypesResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>" 768 } 769 }, 770 "PipelineConfig": { 771 "base": "<p>The pipeline configuration for a resolver of kind <code>PIPELINE</code>.</p>", 772 "refs": { 773 "CreateResolverRequest$pipelineConfig": "<p>The <code>PipelineConfig</code>.</p>", 774 "Resolver$pipelineConfig": "<p>The <code>PipelineConfig</code>.</p>", 775 "UpdateResolverRequest$pipelineConfig": "<p>The <code>PipelineConfig</code>.</p>" 776 } 777 }, 778 "RdsHttpEndpointConfig": { 779 "base": "<p>The Amazon RDS HTTP endpoint configuration.</p>", 780 "refs": { 781 "RelationalDatabaseDataSourceConfig$rdsHttpEndpointConfig": "<p>Amazon RDS HTTP endpoint settings.</p>" 782 } 783 }, 784 "RelationalDatabaseDataSourceConfig": { 785 "base": "<p>Describes a relational database data source configuration.</p>", 786 "refs": { 787 "CreateDataSourceRequest$relationalDatabaseConfig": "<p>Relational database settings.</p>", 788 "DataSource$relationalDatabaseConfig": "<p>Relational database settings.</p>", 789 "UpdateDataSourceRequest$relationalDatabaseConfig": "<p>The new relational database configuration.</p>" 790 } 791 }, 792 "RelationalDatabaseSourceType": { 793 "base": null, 794 "refs": { 795 "RelationalDatabaseDataSourceConfig$relationalDatabaseSourceType": "<p>Source type for the relational database.</p> <ul> <li> <p> <b>RDS_HTTP_ENDPOINT</b>: The relational database source type is an Amazon RDS HTTP endpoint.</p> </li> </ul>" 796 } 797 }, 798 "Resolver": { 799 "base": "<p>Describes a resolver.</p>", 800 "refs": { 801 "CreateResolverResponse$resolver": "<p>The <code>Resolver</code> object.</p>", 802 "GetResolverResponse$resolver": "<p>The <code>Resolver</code> object.</p>", 803 "Resolvers$member": null, 804 "UpdateResolverResponse$resolver": "<p>The updated <code>Resolver</code> object.</p>" 805 } 806 }, 807 "ResolverKind": { 808 "base": null, 809 "refs": { 810 "CreateResolverRequest$kind": "<p>The resolver type.</p> <ul> <li> <p> <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.</p> </li> <li> <p> <b>PIPELINE</b>: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of <code>Function</code> in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.</p> </li> </ul>", 811 "Resolver$kind": "<p>The resolver type.</p> <ul> <li> <p> <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.</p> </li> <li> <p> <b>PIPELINE</b>: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of <code>Function</code> in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.</p> </li> </ul>", 812 "UpdateResolverRequest$kind": "<p>The resolver type.</p> <ul> <li> <p> <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.</p> </li> <li> <p> <b>PIPELINE</b>: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of <code>Function</code> in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.</p> </li> </ul>" 813 } 814 }, 815 "Resolvers": { 816 "base": null, 817 "refs": { 818 "ListResolversByFunctionResponse$resolvers": "<p>The list of resolvers.</p>", 819 "ListResolversResponse$resolvers": "<p>The <code>Resolver</code> objects.</p>" 820 } 821 }, 822 "ResourceArn": { 823 "base": null, 824 "refs": { 825 "ListTagsForResourceRequest$resourceArn": "<p>The <code>GraphqlApi</code> ARN.</p>", 826 "TagResourceRequest$resourceArn": "<p>The <code>GraphqlApi</code> ARN.</p>", 827 "UntagResourceRequest$resourceArn": "<p>The <code>GraphqlApi</code> ARN.</p>" 828 } 829 }, 830 "ResourceName": { 831 "base": null, 832 "refs": { 833 "CreateDataSourceRequest$name": "<p>A user-supplied name for the <code>DataSource</code>.</p>", 834 "CreateFunctionRequest$name": "<p>The <code>Function</code> name. The function name does not have to be unique.</p>", 835 "CreateFunctionRequest$dataSourceName": "<p>The <code>Function</code> <code>DataSource</code> name.</p>", 836 "CreateResolverRequest$typeName": "<p>The name of the <code>Type</code>.</p>", 837 "CreateResolverRequest$fieldName": "<p>The name of the field to attach the resolver to.</p>", 838 "CreateResolverRequest$dataSourceName": "<p>The name of the data source for which the resolver is being created.</p>", 839 "DataSource$name": "<p>The name of the data source.</p>", 840 "DeleteDataSourceRequest$name": "<p>The name of the data source.</p>", 841 "DeleteFunctionRequest$functionId": "<p>The <code>Function</code> ID.</p>", 842 "DeleteResolverRequest$typeName": "<p>The name of the resolver type.</p>", 843 "DeleteResolverRequest$fieldName": "<p>The resolver field name.</p>", 844 "DeleteTypeRequest$typeName": "<p>The type name.</p>", 845 "FunctionConfiguration$name": "<p>The name of the <code>Function</code> object.</p>", 846 "FunctionConfiguration$dataSourceName": "<p>The name of the <code>DataSource</code>.</p>", 847 "GetDataSourceRequest$name": "<p>The name of the data source.</p>", 848 "GetFunctionRequest$functionId": "<p>The <code>Function</code> ID.</p>", 849 "GetResolverRequest$typeName": "<p>The resolver type name.</p>", 850 "GetResolverRequest$fieldName": "<p>The resolver field name.</p>", 851 "GetTypeRequest$typeName": "<p>The type name.</p>", 852 "GraphqlApi$name": "<p>The API name.</p>", 853 "Resolver$typeName": "<p>The resolver type name.</p>", 854 "Resolver$fieldName": "<p>The resolver field name.</p>", 855 "Resolver$dataSourceName": "<p>The resolver data source name.</p>", 856 "Type$name": "<p>The type name.</p>", 857 "UpdateDataSourceRequest$name": "<p>The new name for the data source.</p>", 858 "UpdateFunctionRequest$name": "<p>The <code>Function</code> name.</p>", 859 "UpdateFunctionRequest$functionId": "<p>The function ID.</p>", 860 "UpdateFunctionRequest$dataSourceName": "<p>The <code>Function</code> <code>DataSource</code> name.</p>", 861 "UpdateResolverRequest$typeName": "<p>The new type name.</p>", 862 "UpdateResolverRequest$fieldName": "<p>The new field name.</p>", 863 "UpdateResolverRequest$dataSourceName": "<p>The new data source name.</p>", 864 "UpdateTypeRequest$typeName": "<p>The new type name.</p>" 865 } 866 }, 867 "SchemaStatus": { 868 "base": null, 869 "refs": { 870 "GetSchemaCreationStatusResponse$status": "<p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.</p>", 871 "StartSchemaCreationResponse$status": "<p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.</p>" 872 } 873 }, 874 "StartSchemaCreationRequest": { 875 "base": null, 876 "refs": { 877 } 878 }, 879 "StartSchemaCreationResponse": { 880 "base": null, 881 "refs": { 882 } 883 }, 884 "String": { 885 "base": null, 886 "refs": { 887 "AccessDeniedException$message": null, 888 "ApiKey$id": "<p>The API key ID.</p>", 889 "ApiKey$description": "<p>A description of the purpose of the API key.</p>", 890 "ApiKeyLimitExceededException$message": null, 891 "ApiKeyValidityOutOfBoundsException$message": null, 892 "ApiLimitExceededException$message": null, 893 "AwsIamConfig$signingRegion": "<p>The signing region for AWS IAM authorization.</p>", 894 "AwsIamConfig$signingServiceName": "<p>The signing service name for AWS IAM authorization.</p>", 895 "CachingKeys$member": null, 896 "CognitoUserPoolConfig$userPoolId": "<p>The user pool ID.</p>", 897 "CognitoUserPoolConfig$awsRegion": "<p>The AWS Region in which the user pool was created.</p>", 898 "CognitoUserPoolConfig$appIdClientRegex": "<p>A regular expression for validating the incoming Amazon Cognito user pool app client ID.</p>", 899 "CreateApiCacheRequest$apiId": "<p>The GraphQL API Id.</p>", 900 "CreateApiKeyRequest$apiId": "<p>The ID for your GraphQL API.</p>", 901 "CreateApiKeyRequest$description": "<p>A description of the purpose of the API key.</p>", 902 "CreateDataSourceRequest$apiId": "<p>The API ID for the GraphQL API for the <code>DataSource</code>.</p>", 903 "CreateDataSourceRequest$description": "<p>A description of the <code>DataSource</code>.</p>", 904 "CreateDataSourceRequest$serviceRoleArn": "<p>The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.</p>", 905 "CreateFunctionRequest$apiId": "<p>The GraphQL API ID.</p>", 906 "CreateFunctionRequest$description": "<p>The <code>Function</code> description.</p>", 907 "CreateFunctionRequest$functionVersion": "<p>The <code>version</code> of the request mapping template. Currently the supported value is 2018-05-29. </p>", 908 "CreateGraphqlApiRequest$name": "<p>A user-supplied name for the <code>GraphqlApi</code>.</p>", 909 "CreateResolverRequest$apiId": "<p>The ID for the GraphQL API for which the resolver is being created.</p>", 910 "CreateTypeRequest$apiId": "<p>The API ID.</p>", 911 "CreateTypeRequest$definition": "<p>The type definition, in GraphQL Schema Definition Language (SDL) format.</p> <p>For more information, see the <a href=\"http://graphql.org/learn/schema/\">GraphQL SDL documentation</a>.</p>", 912 "DataSource$dataSourceArn": "<p>The data source ARN.</p>", 913 "DataSource$description": "<p>The description of the data source.</p>", 914 "DataSource$serviceRoleArn": "<p>The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.</p>", 915 "DeleteApiCacheRequest$apiId": "<p>The API ID.</p>", 916 "DeleteApiKeyRequest$apiId": "<p>The API ID.</p>", 917 "DeleteApiKeyRequest$id": "<p>The ID for the API key.</p>", 918 "DeleteDataSourceRequest$apiId": "<p>The API ID.</p>", 919 "DeleteFunctionRequest$apiId": "<p>The GraphQL API ID.</p>", 920 "DeleteGraphqlApiRequest$apiId": "<p>The API ID.</p>", 921 "DeleteResolverRequest$apiId": "<p>The API ID.</p>", 922 "DeleteTypeRequest$apiId": "<p>The API ID.</p>", 923 "DeltaSyncConfig$deltaSyncTableName": "<p>The Delta Sync table name.</p>", 924 "DynamodbDataSourceConfig$tableName": "<p>The table name.</p>", 925 "DynamodbDataSourceConfig$awsRegion": "<p>The AWS Region.</p>", 926 "ElasticsearchDataSourceConfig$endpoint": "<p>The endpoint.</p>", 927 "ElasticsearchDataSourceConfig$awsRegion": "<p>The AWS Region.</p>", 928 "FlushApiCacheRequest$apiId": "<p>The API ID.</p>", 929 "FunctionConfiguration$functionId": "<p>A unique ID representing the <code>Function</code> object.</p>", 930 "FunctionConfiguration$functionArn": "<p>The ARN of the <code>Function</code> object.</p>", 931 "FunctionConfiguration$description": "<p>The <code>Function</code> description.</p>", 932 "FunctionConfiguration$functionVersion": "<p>The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.</p>", 933 "FunctionsIds$member": null, 934 "GetApiCacheRequest$apiId": "<p>The API ID.</p>", 935 "GetDataSourceRequest$apiId": "<p>The API ID.</p>", 936 "GetFunctionRequest$apiId": "<p>The GraphQL API ID.</p>", 937 "GetGraphqlApiRequest$apiId": "<p>The API ID for the GraphQL API.</p>", 938 "GetIntrospectionSchemaRequest$apiId": "<p>The API ID.</p>", 939 "GetResolverRequest$apiId": "<p>The API ID.</p>", 940 "GetSchemaCreationStatusRequest$apiId": "<p>The API ID.</p>", 941 "GetSchemaCreationStatusResponse$details": "<p>Detailed information about the status of the schema creation operation.</p>", 942 "GetTypeRequest$apiId": "<p>The API ID.</p>", 943 "GraphqlApi$apiId": "<p>The API ID.</p>", 944 "GraphqlApi$arn": "<p>The ARN.</p>", 945 "GraphqlApi$wafWebAclArn": "<p>The ARN of the AWS Web Application Firewall (WAF) ACL associated with this <code>GraphqlApi</code>, if one exists.</p>", 946 "HttpDataSourceConfig$endpoint": "<p>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.</p>", 947 "InternalFailureException$message": null, 948 "LambdaConflictHandlerConfig$lambdaConflictHandlerArn": "<p>The Arn for the Lambda function to use as the Conflict Handler.</p>", 949 "LambdaDataSourceConfig$lambdaFunctionArn": "<p>The ARN for the Lambda function.</p>", 950 "LimitExceededException$message": null, 951 "ListApiKeysRequest$apiId": "<p>The API ID.</p>", 952 "ListDataSourcesRequest$apiId": "<p>The API ID.</p>", 953 "ListFunctionsRequest$apiId": "<p>The GraphQL API ID.</p>", 954 "ListResolversByFunctionRequest$apiId": "<p>The API ID.</p>", 955 "ListResolversByFunctionRequest$functionId": "<p>The Function ID.</p>", 956 "ListResolversRequest$apiId": "<p>The API ID.</p>", 957 "ListResolversRequest$typeName": "<p>The type name.</p>", 958 "ListTypesRequest$apiId": "<p>The API ID.</p>", 959 "LogConfig$cloudWatchLogsRoleArn": "<p>The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account. </p>", 960 "MapOfStringToString$key": null, 961 "MapOfStringToString$value": null, 962 "NotFoundException$message": null, 963 "OpenIDConnectConfig$issuer": "<p>The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of <code>iss</code> in the ID token.</p>", 964 "OpenIDConnectConfig$clientId": "<p>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.</p>", 965 "RdsHttpEndpointConfig$awsRegion": "<p>AWS Region for RDS HTTP endpoint.</p>", 966 "RdsHttpEndpointConfig$dbClusterIdentifier": "<p>Amazon RDS cluster ARN.</p>", 967 "RdsHttpEndpointConfig$databaseName": "<p>Logical database name.</p>", 968 "RdsHttpEndpointConfig$schema": "<p>Logical schema name.</p>", 969 "RdsHttpEndpointConfig$awsSecretStoreArn": "<p>AWS secret store ARN for database credentials.</p>", 970 "Resolver$resolverArn": "<p>The resolver ARN.</p>", 971 "StartSchemaCreationRequest$apiId": "<p>The API ID.</p>", 972 "Type$description": "<p>The type description.</p>", 973 "Type$arn": "<p>The type ARN.</p>", 974 "Type$definition": "<p>The type definition.</p>", 975 "UnauthorizedException$message": null, 976 "UpdateApiCacheRequest$apiId": "<p>The GraphQL API Id.</p>", 977 "UpdateApiKeyRequest$apiId": "<p>The ID for the GraphQL API.</p>", 978 "UpdateApiKeyRequest$id": "<p>The API key ID.</p>", 979 "UpdateApiKeyRequest$description": "<p>A description of the purpose of the API key.</p>", 980 "UpdateDataSourceRequest$apiId": "<p>The API ID.</p>", 981 "UpdateDataSourceRequest$description": "<p>The new description for the data source.</p>", 982 "UpdateDataSourceRequest$serviceRoleArn": "<p>The new service role ARN for the data source.</p>", 983 "UpdateFunctionRequest$apiId": "<p>The GraphQL API ID.</p>", 984 "UpdateFunctionRequest$description": "<p>The <code>Function</code> description.</p>", 985 "UpdateFunctionRequest$functionVersion": "<p>The <code>version</code> of the request mapping template. Currently the supported value is 2018-05-29. </p>", 986 "UpdateGraphqlApiRequest$apiId": "<p>The API ID.</p>", 987 "UpdateGraphqlApiRequest$name": "<p>The new name for the <code>GraphqlApi</code> object.</p>", 988 "UpdateResolverRequest$apiId": "<p>The API ID.</p>", 989 "UpdateTypeRequest$apiId": "<p>The API ID.</p>", 990 "UpdateTypeRequest$definition": "<p>The new definition.</p>", 991 "UserPoolConfig$userPoolId": "<p>The user pool ID.</p>", 992 "UserPoolConfig$awsRegion": "<p>The AWS Region in which the user pool was created.</p>", 993 "UserPoolConfig$appIdClientRegex": "<p>A regular expression for validating the incoming Amazon Cognito user pool app client ID.</p>" 994 } 995 }, 996 "SyncConfig": { 997 "base": "<p>Describes a Sync configuration for a resolver.</p> <p>Contains information on which Conflict Detection as well as Resolution strategy should be performed when the resolver is invoked.</p>", 998 "refs": { 999 "CreateFunctionRequest$syncConfig": null, 1000 "CreateResolverRequest$syncConfig": "<p>The <code>SyncConfig</code> for a resolver attached to a versioned datasource.</p>", 1001 "FunctionConfiguration$syncConfig": null, 1002 "Resolver$syncConfig": "<p>The <code>SyncConfig</code> for a resolver attached to a versioned datasource.</p>", 1003 "UpdateFunctionRequest$syncConfig": null, 1004 "UpdateResolverRequest$syncConfig": "<p>The <code>SyncConfig</code> for a resolver attached to a versioned datasource.</p>" 1005 } 1006 }, 1007 "TagKey": { 1008 "base": "<p>The key for the tag.</p>", 1009 "refs": { 1010 "TagKeyList$member": null, 1011 "TagMap$key": null 1012 } 1013 }, 1014 "TagKeyList": { 1015 "base": null, 1016 "refs": { 1017 "UntagResourceRequest$tagKeys": "<p>A list of <code>TagKey</code> objects.</p>" 1018 } 1019 }, 1020 "TagMap": { 1021 "base": "<p>A map with keys of <code>TagKey</code> objects and values of <code>TagValue</code> objects.</p>", 1022 "refs": { 1023 "CreateGraphqlApiRequest$tags": "<p>A <code>TagMap</code> object.</p>", 1024 "GraphqlApi$tags": "<p>The tags.</p>", 1025 "ListTagsForResourceResponse$tags": "<p>A <code>TagMap</code> object.</p>", 1026 "TagResourceRequest$tags": "<p>A <code>TagMap</code> object.</p>" 1027 } 1028 }, 1029 "TagResourceRequest": { 1030 "base": null, 1031 "refs": { 1032 } 1033 }, 1034 "TagResourceResponse": { 1035 "base": null, 1036 "refs": { 1037 } 1038 }, 1039 "TagValue": { 1040 "base": "<p>The value for the tag.</p>", 1041 "refs": { 1042 "TagMap$value": null 1043 } 1044 }, 1045 "Type": { 1046 "base": "<p>Describes a type.</p>", 1047 "refs": { 1048 "CreateTypeResponse$type": "<p>The <code>Type</code> object.</p>", 1049 "GetTypeResponse$type": "<p>The <code>Type</code> object.</p>", 1050 "TypeList$member": null, 1051 "UpdateTypeResponse$type": "<p>The updated <code>Type</code> object.</p>" 1052 } 1053 }, 1054 "TypeDefinitionFormat": { 1055 "base": null, 1056 "refs": { 1057 "CreateTypeRequest$format": "<p>The type format: SDL or JSON.</p>", 1058 "GetTypeRequest$format": "<p>The type format: SDL or JSON.</p>", 1059 "ListTypesRequest$format": "<p>The type format: SDL or JSON.</p>", 1060 "Type$format": "<p>The type format: SDL or JSON.</p>", 1061 "UpdateTypeRequest$format": "<p>The new type format: SDL or JSON.</p>" 1062 } 1063 }, 1064 "TypeList": { 1065 "base": null, 1066 "refs": { 1067 "ListTypesResponse$types": "<p>The <code>Type</code> objects.</p>" 1068 } 1069 }, 1070 "UnauthorizedException": { 1071 "base": "<p>You are not authorized to perform this operation.</p>", 1072 "refs": { 1073 } 1074 }, 1075 "UntagResourceRequest": { 1076 "base": null, 1077 "refs": { 1078 } 1079 }, 1080 "UntagResourceResponse": { 1081 "base": null, 1082 "refs": { 1083 } 1084 }, 1085 "UpdateApiCacheRequest": { 1086 "base": "<p>Represents the input of a <code>UpdateApiCache</code> operation.</p>", 1087 "refs": { 1088 } 1089 }, 1090 "UpdateApiCacheResponse": { 1091 "base": "<p>Represents the output of a <code>UpdateApiCache</code> operation.</p>", 1092 "refs": { 1093 } 1094 }, 1095 "UpdateApiKeyRequest": { 1096 "base": null, 1097 "refs": { 1098 } 1099 }, 1100 "UpdateApiKeyResponse": { 1101 "base": null, 1102 "refs": { 1103 } 1104 }, 1105 "UpdateDataSourceRequest": { 1106 "base": null, 1107 "refs": { 1108 } 1109 }, 1110 "UpdateDataSourceResponse": { 1111 "base": null, 1112 "refs": { 1113 } 1114 }, 1115 "UpdateFunctionRequest": { 1116 "base": null, 1117 "refs": { 1118 } 1119 }, 1120 "UpdateFunctionResponse": { 1121 "base": null, 1122 "refs": { 1123 } 1124 }, 1125 "UpdateGraphqlApiRequest": { 1126 "base": null, 1127 "refs": { 1128 } 1129 }, 1130 "UpdateGraphqlApiResponse": { 1131 "base": null, 1132 "refs": { 1133 } 1134 }, 1135 "UpdateResolverRequest": { 1136 "base": null, 1137 "refs": { 1138 } 1139 }, 1140 "UpdateResolverResponse": { 1141 "base": null, 1142 "refs": { 1143 } 1144 }, 1145 "UpdateTypeRequest": { 1146 "base": null, 1147 "refs": { 1148 } 1149 }, 1150 "UpdateTypeResponse": { 1151 "base": null, 1152 "refs": { 1153 } 1154 }, 1155 "UserPoolConfig": { 1156 "base": "<p>Describes an Amazon Cognito user pool configuration.</p>", 1157 "refs": { 1158 "CreateGraphqlApiRequest$userPoolConfig": "<p>The Amazon Cognito user pool configuration.</p>", 1159 "GraphqlApi$userPoolConfig": "<p>The Amazon Cognito user pool configuration.</p>", 1160 "UpdateGraphqlApiRequest$userPoolConfig": "<p>The new Amazon Cognito user pool configuration for the <code>GraphqlApi</code> object.</p>" 1161 } 1162 } 1163 } 1164} 1165