AWS AppSync - API Reference€¦ · The GraphQL API Id. Required: Yes Request Body The request accepts the following data in JSON format. apiCachingBehavior (p. 4) Caching behavior

AWS AppSyncAPI Reference

API Version 2017-07-25

AWS AppSync API Reference

AWS AppSync: API ReferenceCopyright © 2021 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

CreateApiCache .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

CreateApiKey .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

CreateDataSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

CreateFunction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

CreateGraphqlApi ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

CreateResolver ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

CreateType .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

API Version 2017-07-25iii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

DeleteApiCache .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

DeleteApiKey .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

DeleteDataSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

DeleteFunction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

DeleteGraphqlApi ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

DeleteResolver ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

DeleteType .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

API Version 2017-07-25iv


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

FlushApiCache .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

GetApiCache .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

GetDataSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

GetFunction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

GetGraphqlApi ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

GetIntrospectionSchema .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

GetResolver ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

API Version 2017-07-25v


Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

GetSchemaCreationStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

GetType .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

ListApiKeys .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

ListDataSources .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

ListFunctions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

ListGraphqlApis ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

ListResolvers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

API Version 2017-07-25vi


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82ListResolversByFunction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

ListTypes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

StartSchemaCreation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

UpdateApiCache .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

API Version 2017-07-25vii


UpdateApiKey .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

UpdateDataSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

UpdateFunction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

UpdateGraphqlApi ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

UpdateResolver ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

UpdateType .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125AdditionalAuthenticationProvider ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

ApiCache .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

ApiKey .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

API Version 2017-07-25viii


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130AuthorizationConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131


AwsIamConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

CachingConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

CognitoUserPoolConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

DataSource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

DeltaSyncConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

DynamodbDataSourceConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

ElasticsearchDataSourceConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

FunctionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

GraphqlApi ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

HttpDataSourceConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

LambdaConflictHandlerConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

LambdaDataSourceConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

LogConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

OpenIDConnectConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

PipelineConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

RdsHttpEndpointConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

RelationalDatabaseDataSourceConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Resolver ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

API Version 2017-07-25ix


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153SyncConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154


Type .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

UserPoolConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

API Version 2017-07-25x


WelcomeAWS AppSync provides API actions for creating and interacting with data sources using GraphQL fromyour application.

This document was last published on February 17, 2021.



ActionsThe following actions are supported:

• CreateApiCache (p. 4)• CreateApiKey (p. 8)• CreateDataSource (p. 11)• CreateFunction (p. 16)• CreateGraphqlApi (p. 20)• CreateResolver (p. 25)• CreateType (p. 29)• DeleteApiCache (p. 32)• DeleteApiKey (p. 34)• DeleteDataSource (p. 36)• DeleteFunction (p. 38)• DeleteGraphqlApi (p. 40)• DeleteResolver (p. 42)• DeleteType (p. 44)• FlushApiCache (p. 46)• GetApiCache (p. 48)• GetDataSource (p. 50)• GetFunction (p. 53)• GetGraphqlApi (p. 55)• GetIntrospectionSchema (p. 58)• GetResolver (p. 60)• GetSchemaCreationStatus (p. 63)• GetType (p. 65)• ListApiKeys (p. 68)• ListDataSources (p. 71)• ListFunctions (p. 74)• ListGraphqlApis (p. 77)• ListResolvers (p. 80)• ListResolversByFunction (p. 83)• ListTagsForResource (p. 86)• ListTypes (p. 88)• StartSchemaCreation (p. 91)• TagResource (p. 94)• UntagResource (p. 97)• UpdateApiCache (p. 99)• UpdateApiKey (p. 102)• UpdateDataSource (p. 105)• UpdateFunction (p. 110)• UpdateGraphqlApi (p. 114)• UpdateResolver (p. 118)



• UpdateType (p. 122)


AWS AppSync API ReferenceCreateApiCache

CreateApiCacheCreates a cache for the GraphQL API.

Request SyntaxPOST /v1/apis/apiId/ApiCaches HTTP/1.1Content-type: application/json

{ "apiCachingBehavior": "string", "atRestEncryptionEnabled": boolean, "transitEncryptionEnabled": boolean, "ttl": number, "type": "string"}

URI Request ParametersThe request uses the following URI parameters.

apiId (p. 4)

The GraphQL API Id.

Required: Yes

Request BodyThe request accepts the following data in JSON format.

apiCachingBehavior (p. 4)

Caching behavior.• FULL_REQUEST_CACHING: All requests are fully cached.• PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

Type: String

Valid Values: FULL_REQUEST_CACHING | PER_RESOLVER_CACHING

Required: YesatRestEncryptionEnabled (p. 4)

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

Type: Boolean

Required: NotransitEncryptionEnabled (p. 4)

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

Type: Boolean


AWS AppSync API ReferenceResponse Syntax

Required: Nottl (p. 4)

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Type: Long

Required: Yestype (p. 4)

The cache instance type. Valid values are• SMALL

• MEDIUM

• LARGE

• XLARGE

• LARGE_2X

• LARGE_4X

• LARGE_8X (not available in all regions)• LARGE_12X

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

The following legacy instance types are available, but their use is discouraged:• T2_SMALL: A t2.small instance type.• T2_MEDIUM: A t2.medium instance type.• R4_LARGE: A r4.large instance type.• R4_XLARGE: A r4.xlarge instance type.• R4_2XLARGE: A r4.2xlarge instance type.• R4_4XLARGE: A r4.4xlarge instance type.• R4_8XLARGE: A r4.8xlarge instance type.

Type: String

Valid Values: T2_SMALL | T2_MEDIUM | R4_LARGE | R4_XLARGE | R4_2XLARGE |R4_4XLARGE | R4_8XLARGE | SMALL | MEDIUM | LARGE | XLARGE | LARGE_2X |LARGE_4X | LARGE_8X | LARGE_12X

Required: Yes

Response SyntaxHTTP/1.1 200Content-type: application/json

{ "apiCache": { "apiCachingBehavior": "string", "atRestEncryptionEnabled": boolean, "status": "string", "transitEncryptionEnabled": boolean, "ttl": number,


AWS AppSync API ReferenceResponse Elements

"type": "string" }}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

apiCache (p. 5)

The ApiCache object.

Type: ApiCache (p. 127) object

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 160).

BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Checkthe field values, and then try again.

HTTP Status Code: 400ConcurrentModificationException

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

HTTP Status Code: 409InternalFailureException

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

HTTP Status Code: 500NotFoundException

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

HTTP Status Code: 404UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++


https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/CreateApiCache

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/CreateApiCache

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateApiCache

AWS AppSync API ReferenceSee Also

• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/CreateApiCache

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateApiCache

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/CreateApiCache

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateApiCache

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateApiCache

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateApiCache

AWS AppSync API ReferenceCreateApiKey

CreateApiKeyCreates a unique key that you can distribute to clients who are executing your API.

Request SyntaxPOST /v1/apis/apiId/apikeys HTTP/1.1Content-type: application/json

{ "description": "string", "expires": number}


apiId (p. 8)

The ID for your GraphQL API.

Required: Yes


description (p. 8)

A description of the purpose of the API key.

Type: String

Required: Noexpires (p. 8)

The time from creation time after which the API key expires. The date is represented as seconds sincethe epoch, rounded down to the nearest hour. The default value for this parameter is 7 days fromcreation time. For more information, see ApiKey (p. 129).

Type: Long

Required: No


{ "apiKey": { "deletes": number, "description": "string",



"expires": number, "id": "string" }}



apiKey (p. 8)

The API key.

Type: ApiKey (p. 129) object


ApiKeyLimitExceededException

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

HTTP Status Code: 400ApiKeyValidityOutOfBoundsException

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

HTTP Status Code: 400BadRequestException




HTTP Status Code: 500LimitExceededException

The request exceeded a limit. Try your request again.











• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/CreateApiKey

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/CreateApiKey

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateApiKey

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/CreateApiKey

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateApiKey

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/CreateApiKey

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateApiKey

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateApiKey

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateApiKey

AWS AppSync API ReferenceCreateDataSource

CreateDataSourceCreates a DataSource object.

Request SyntaxPOST /v1/apis/apiId/datasources HTTP/1.1Content-type: application/json

{ "description": "string", "dynamodbConfig": { "awsRegion": "string", "deltaSyncConfig": { "baseTableTTL": number, "deltaSyncTableName": "string", "deltaSyncTableTTL": number }, "tableName": "string", "useCallerCredentials": boolean, "versioned": boolean }, "elasticsearchConfig": { "awsRegion": "string", "endpoint": "string" }, "httpConfig": { "authorizationConfig": { "authorizationType": "string", "awsIamConfig": { "signingRegion": "string", "signingServiceName": "string" } }, "endpoint": "string" }, "lambdaConfig": { "lambdaFunctionArn": "string" }, "name": "string", "relationalDatabaseConfig": { "rdsHttpEndpointConfig": { "awsRegion": "string", "awsSecretStoreArn": "string", "databaseName": "string", "dbClusterIdentifier": "string", "schema": "string" }, "relationalDatabaseSourceType": "string" }, "serviceRoleArn": "string", "type": "string"}


apiId (p. 11)

The API ID for the GraphQL API for the DataSource.


AWS AppSync API ReferenceRequest Body

Required: Yes


description (p. 11)

A description of the DataSource.

Type: String

Required: NodynamodbConfig (p. 11)

Amazon DynamoDB settings.

Type: DynamodbDataSourceConfig (p. 138) object

Required: NoelasticsearchConfig (p. 11)

Amazon Elasticsearch Service settings.

Type: ElasticsearchDataSourceConfig (p. 139) object

Required: NohttpConfig (p. 11)

HTTP endpoint settings.

Type: HttpDataSourceConfig (p. 144) object

Required: NolambdaConfig (p. 11)

AWS Lambda settings.

Type: LambdaDataSourceConfig (p. 146) object

Required: Noname (p. 11)

A user-supplied name for the DataSource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65536.

Pattern: [_A-Za-z][_0-9A-Za-z]*

Required: YesrelationalDatabaseConfig (p. 11)

Relational database settings.

Type: RelationalDatabaseDataSourceConfig (p. 151) object

Required: No



serviceRoleArn (p. 11)

The AWS IAM service role ARN for the data source. The system assumes this role when accessing thedata source.

Type: String

Required: Notype (p. 11)

The type of the DataSource.

Type: String

Valid Values: AWS_LAMBDA | AMAZON_DYNAMODB | AMAZON_ELASTICSEARCH | NONE | HTTP| RELATIONAL_DATABASE

Required: Yes


{ "dataSource": { "dataSourceArn": "string", "description": "string", "dynamodbConfig": { "awsRegion": "string", "deltaSyncConfig": { "baseTableTTL": number, "deltaSyncTableName": "string", "deltaSyncTableTTL": number }, "tableName": "string", "useCallerCredentials": boolean, "versioned": boolean }, "elasticsearchConfig": { "awsRegion": "string", "endpoint": "string" }, "httpConfig": { "authorizationConfig": { "authorizationType": "string", "awsIamConfig": { "signingRegion": "string", "signingServiceName": "string" } }, "endpoint": "string" }, "lambdaConfig": { "lambdaFunctionArn": "string" }, "name": "string", "relationalDatabaseConfig": { "rdsHttpEndpointConfig": { "awsRegion": "string", "awsSecretStoreArn": "string", "databaseName": "string",



"dbClusterIdentifier": "string", "schema": "string" }, "relationalDatabaseSourceType": "string" }, "serviceRoleArn": "string", "type": "string" }}



dataSource (p. 13)

The DataSource object.

Type: DataSource (p. 135) object


BadRequestException
















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/CreateDataSource

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/CreateDataSource

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateDataSource

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/CreateDataSource

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateDataSource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/CreateDataSource

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateDataSource

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateDataSource

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateDataSource

AWS AppSync API ReferenceCreateFunction

CreateFunctionCreates a Function object.

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

Request SyntaxPOST /v1/apis/apiId/functions HTTP/1.1Content-type: application/json

{ "dataSourceName": "string", "description": "string", "functionVersion": "string", "name": "string", "requestMappingTemplate": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } }}


apiId (p. 16)

The GraphQL API ID.

Required: Yes


dataSourceName (p. 16)

The Function DataSource name.

Type: String



Required: Yesdescription (p. 16)

The Function description.

Type: String



Required: NofunctionVersion (p. 16)

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

Type: String

Required: Yesname (p. 16)

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

Type: String



Required: YesrequestMappingTemplate (p. 16)

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

Type: String


Required: NoresponseMappingTemplate (p. 16)

The Function response mapping template.

Type: String


Required: NosyncConfig (p. 16)

Describes a Sync configuration for a resolver.

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

Type: SyncConfig (p. 154) object

Required: No


{ "functionConfiguration": { "dataSourceName": "string", "description": "string",



"functionArn": "string", "functionId": "string", "functionVersion": "string", "name": "string", "requestMappingTemplate": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } } }}



functionConfiguration (p. 17)

The Function object.

Type: FunctionConfiguration (p. 140) object


ConcurrentModificationException














https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/CreateFunction

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/CreateFunction

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateFunction

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/CreateFunction

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateFunction

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/CreateFunction

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateFunction

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateFunction

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateFunction

AWS AppSync API ReferenceCreateGraphqlApi

CreateGraphqlApiCreates a GraphqlApi object.

Request Syntax

POST /v1/apis HTTP/1.1Content-type: application/json

{ "additionalAuthenticationProviders": [ { "authenticationType": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "userPoolId": "string" } } ], "authenticationType": "string", "logConfig": { "cloudWatchLogsRoleArn": "string", "excludeVerboseContent": boolean, "fieldLogLevel": "string" }, "name": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "tags": { "string" : "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string" }, "xrayEnabled": boolean}

URI Request ParametersThe request does not use any URI parameters.




additionalAuthenticationProviders (p. 20)

A list of additional authentication providers for the GraphqlApi API.

Type: Array of AdditionalAuthenticationProvider (p. 126) objects

Required: NoauthenticationType (p. 20)

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

Type: String

Valid Values: API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT

Required: YeslogConfig (p. 20)

The Amazon CloudWatch Logs configuration.

Type: LogConfig (p. 147) object


A user-supplied name for the GraphqlApi.

Type: String

Required: YesopenIDConnectConfig (p. 20)

The OpenID Connect configuration.

Type: OpenIDConnectConfig (p. 148) object

Required: Notags (p. 20)

A TagMap object.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: NouserPoolConfig (p. 20)

The Amazon Cognito user pool configuration.

Type: UserPoolConfig (p. 157) object

Required: No



xrayEnabled (p. 20)

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

Type: Boolean

Required: No


{ "graphqlApi": { "additionalAuthenticationProviders": [ { "authenticationType": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "userPoolId": "string" } } ], "apiId": "string", "arn": "string", "authenticationType": "string", "logConfig": { "cloudWatchLogsRoleArn": "string", "excludeVerboseContent": boolean, "fieldLogLevel": "string" }, "name": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "tags": { "string" : "string" }, "uris": { "string" : "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string" }, "wafWebAclArn": "string", "xrayEnabled": boolean }}





graphqlApi (p. 22)

The GraphqlApi.

Type: GraphqlApi (p. 142) object


ApiLimitExceededException

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













• AWS Command Line Interface• AWS SDK for .NET


https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/CreateGraphqlApi

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/CreateGraphqlApi


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateGraphqlApi

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/CreateGraphqlApi

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateGraphqlApi

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/CreateGraphqlApi

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateGraphqlApi

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateGraphqlApi

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateGraphqlApi

AWS AppSync API ReferenceCreateResolver

CreateResolverCreates a Resolver object.

A resolver converts incoming requests into a format that a data source can understand and converts thedata source's responses into GraphQL.

Request SyntaxPOST /v1/apis/apiId/types/typeName/resolvers HTTP/1.1Content-type: application/json

{ "cachingConfig": { "cachingKeys": [ "string" ], "ttl": number }, "dataSourceName": "string", "fieldName": "string", "kind": "string", "pipelineConfig": { "functions": [ "string" ] }, "requestMappingTemplate": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } }}


apiId (p. 25)

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

Required: YestypeName (p. 25)

The name of the Type.



Required: Yes




cachingConfig (p. 25)

The caching configuration for the resolver.

Type: CachingConfig (p. 133) object

Required: NodataSourceName (p. 25)

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

Type: String



Required: NofieldName (p. 25)

The name of the field to attach the resolver to.

Type: String



Required: Yeskind (p. 25)

The resolver type.• UNIT: 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.• PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series ofFunction in a serial manner. You can use a pipeline resolver to execute a GraphQL query againstmultiple data sources.

Type: String

Valid Values: UNIT | PIPELINE

Required: NopipelineConfig (p. 25)

The PipelineConfig.

Type: PipelineConfig (p. 149) object

Required: NorequestMappingTemplate (p. 25)

The mapping template to be used for requests.

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

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



Type: String


Required: No

responseMappingTemplate (p. 25)

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

Type: String


Required: No

syncConfig (p. 25)

The SyncConfig for a resolver attached to a versioned datasource.


Required: No


{ "resolver": { "cachingConfig": { "cachingKeys": [ "string" ], "ttl": number }, "dataSourceName": "string", "fieldName": "string", "kind": "string", "pipelineConfig": { "functions": [ "string" ] }, "requestMappingTemplate": "string", "resolverArn": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } }, "typeName": "string" }}




AWS AppSync API ReferenceErrors

resolver (p. 27)

The Resolver object.

Type: Resolver (p. 152) object














https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/CreateResolver

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/CreateResolver

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateResolver

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/CreateResolver

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateResolver

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/CreateResolver

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateResolver

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateResolver

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateResolver

AWS AppSync API ReferenceCreateType

CreateTypeCreates a Type object.

Request SyntaxPOST /v1/apis/apiId/types HTTP/1.1Content-type: application/json

{ "definition": "string", "format": "string"}


apiId (p. 29)

The API ID.

Required: Yes


definition (p. 29)

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

For more information, see the GraphQL SDL documentation.

Type: String

Required: Yesformat (p. 29)

The type format: SDL or JSON.

Type: String

Valid Values: SDL | JSON

Required: Yes


{ "type": {


http://graphql.org/learn/schema/


"arn": "string", "definition": "string", "description": "string", "format": "string", "name": "string" }}



type (p. 29)

The Type object.

Type: Type (p. 155) object


BadRequestException
















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/CreateType

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/CreateType

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateType

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/CreateType

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateType

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/CreateType

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateType

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateType

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateType

AWS AppSync API ReferenceDeleteApiCache

DeleteApiCacheDeletes an ApiCache object.

Request SyntaxDELETE /v1/apis/apiId/ApiCaches HTTP/1.1


apiId (p. 32)

The API ID.

Required: Yes

Request BodyThe request does not have a request body.

Response SyntaxHTTP/1.1 200

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


BadRequestException









NotFoundException








https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/DeleteApiCache

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/DeleteApiCache

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteApiCache

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/DeleteApiCache

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteApiCache

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/DeleteApiCache

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteApiCache

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteApiCache

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteApiCache

AWS AppSync API ReferenceDeleteApiKey

DeleteApiKeyDeletes an API key.

Request SyntaxDELETE /v1/apis/apiId/apikeys/id HTTP/1.1


apiId (p. 34)

The API ID.

Required: Yesid (p. 34)

The ID for the API key.

Required: Yes





BadRequestException







NotFoundException








https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/DeleteApiKey

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/DeleteApiKey

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteApiKey

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/DeleteApiKey

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteApiKey

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/DeleteApiKey

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteApiKey

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteApiKey

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteApiKey

AWS AppSync API ReferenceDeleteDataSource

DeleteDataSourceDeletes a DataSource object.

Request SyntaxDELETE /v1/apis/apiId/datasources/name HTTP/1.1


apiId (p. 36)

The API ID.


The name of the data source.



Required: Yes





BadRequestException
















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/DeleteDataSource

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/DeleteDataSource

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteDataSource

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/DeleteDataSource

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteDataSource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/DeleteDataSource

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteDataSource

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteDataSource

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteDataSource

AWS AppSync API ReferenceDeleteFunction

DeleteFunctionDeletes a Function.

Request SyntaxDELETE /v1/apis/apiId/functions/functionId HTTP/1.1


apiId (p. 38)

The GraphQL API ID.

Required: YesfunctionId (p. 38)

The Function ID.



Required: Yes



















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/DeleteFunction

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/DeleteFunction

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteFunction

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/DeleteFunction

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteFunction

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/DeleteFunction

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteFunction

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteFunction

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteFunction

AWS AppSync API ReferenceDeleteGraphqlApi

DeleteGraphqlApiDeletes a GraphqlApi object.

Request SyntaxDELETE /v1/apis/apiId HTTP/1.1


apiId (p. 40)

The API ID.

Required: Yes





AccessDeniedException

You do not have access to perform this operation on this resource.








InternalFailureException










https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/DeleteGraphqlApi

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/DeleteGraphqlApi

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteGraphqlApi

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/DeleteGraphqlApi

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteGraphqlApi

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/DeleteGraphqlApi

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteGraphqlApi

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteGraphqlApi

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteGraphqlApi

AWS AppSync API ReferenceDeleteResolver

DeleteResolverDeletes a Resolver object.

Request SyntaxDELETE /v1/apis/apiId/types/typeName/resolvers/fieldName HTTP/1.1


apiId (p. 42)

The API ID.

Required: YesfieldName (p. 42)

The resolver field name.




The name of the resolver type.



Required: Yes



















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/DeleteResolver

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/DeleteResolver

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteResolver

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/DeleteResolver

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteResolver

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/DeleteResolver

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteResolver

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteResolver

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteResolver

AWS AppSync API ReferenceDeleteType

DeleteTypeDeletes a Type object.

Request SyntaxDELETE /v1/apis/apiId/types/typeName HTTP/1.1


apiId (p. 44)

The API ID.


The type name.



Required: Yes





BadRequestException
















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/DeleteType

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/DeleteType

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteType

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/DeleteType

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteType

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/DeleteType

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteType

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteType

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteType

AWS AppSync API ReferenceFlushApiCache

FlushApiCacheFlushes an ApiCache object.

Request SyntaxDELETE /v1/apis/apiId/FlushCache HTTP/1.1


apiId (p. 46)

The API ID.

Required: Yes





BadRequestException









NotFoundException








https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/FlushApiCache

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/FlushApiCache

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/FlushApiCache

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/FlushApiCache

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/FlushApiCache

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/FlushApiCache

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/FlushApiCache

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/FlushApiCache

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/FlushApiCache

AWS AppSync API ReferenceGetApiCache

GetApiCacheRetrieves an ApiCache object.

Request SyntaxGET /v1/apis/apiId/ApiCaches HTTP/1.1


apiId (p. 48)

The API ID.

Required: Yes



{ "apiCache": { "apiCachingBehavior": "string", "atRestEncryptionEnabled": boolean, "status": "string", "transitEncryptionEnabled": boolean, "ttl": number, "type": "string" }}



apiCache (p. 48)






BadRequestException














https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/GetApiCache

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/GetApiCache

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetApiCache

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/GetApiCache

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetApiCache

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/GetApiCache

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetApiCache

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetApiCache

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetApiCache

AWS AppSync API ReferenceGetDataSource

GetDataSourceRetrieves a DataSource object.

Request SyntaxGET /v1/apis/apiId/datasources/name HTTP/1.1


apiId (p. 50)

The API ID.





Required: Yes



{ "dataSource": { "dataSourceArn": "string", "description": "string", "dynamodbConfig": { "awsRegion": "string", "deltaSyncConfig": { "baseTableTTL": number, "deltaSyncTableName": "string", "deltaSyncTableTTL": number }, "tableName": "string", "useCallerCredentials": boolean, "versioned": boolean }, "elasticsearchConfig": { "awsRegion": "string", "endpoint": "string" },



"httpConfig": { "authorizationConfig": { "authorizationType": "string", "awsIamConfig": { "signingRegion": "string", "signingServiceName": "string" } }, "endpoint": "string" }, "lambdaConfig": { "lambdaFunctionArn": "string" }, "name": "string", "relationalDatabaseConfig": { "rdsHttpEndpointConfig": { "awsRegion": "string", "awsSecretStoreArn": "string", "databaseName": "string", "dbClusterIdentifier": "string", "schema": "string" }, "relationalDatabaseSourceType": "string" }, "serviceRoleArn": "string", "type": "string" }}



dataSource (p. 50)

The DataSource object.



BadRequestException
















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/GetDataSource

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/GetDataSource

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetDataSource

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/GetDataSource

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetDataSource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/GetDataSource

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetDataSource

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetDataSource

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetDataSource

AWS AppSync API ReferenceGetFunction

GetFunctionGet a Function.

Request SyntaxGET /v1/apis/apiId/functions/functionId HTTP/1.1


apiId (p. 53)

The GraphQL API ID.


The Function ID.



Required: Yes



{ "functionConfiguration": { "dataSourceName": "string", "description": "string", "functionArn": "string", "functionId": "string", "functionVersion": "string", "name": "string", "requestMappingTemplate": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } } }}



















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/GetFunction

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/GetFunction

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetFunction

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/GetFunction

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetFunction

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/GetFunction

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetFunction

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetFunction

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetFunction

AWS AppSync API ReferenceGetGraphqlApi

GetGraphqlApiRetrieves a GraphqlApi object.

Request SyntaxGET /v1/apis/apiId HTTP/1.1


apiId (p. 55)

The API ID for the GraphQL API.

Required: Yes



{ "graphqlApi": { "additionalAuthenticationProviders": [ { "authenticationType": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "userPoolId": "string" } } ], "apiId": "string", "arn": "string", "authenticationType": "string", "logConfig": { "cloudWatchLogsRoleArn": "string", "excludeVerboseContent": boolean, "fieldLogLevel": "string" }, "name": "string", "openIDConnectConfig": { "authTTL": number,



"clientId": "string", "iatTTL": number, "issuer": "string" }, "tags": { "string" : "string" }, "uris": { "string" : "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string" }, "wafWebAclArn": "string", "xrayEnabled": boolean }}



graphqlApi (p. 55)

The GraphqlApi object.














UnauthorizedException






https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/GetGraphqlApi

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/GetGraphqlApi

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetGraphqlApi

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/GetGraphqlApi

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetGraphqlApi

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/GetGraphqlApi

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetGraphqlApi

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetGraphqlApi

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetGraphqlApi

AWS AppSync API ReferenceGetIntrospectionSchema

GetIntrospectionSchemaRetrieves the introspection schema for a GraphQL API.

Request SyntaxGET /v1/apis/apiId/schema?format=format&includeDirectives=includeDirectives HTTP/1.1


apiId (p. 58)

The API ID.


The schema format: SDL or JSON.


Required: YesincludeDirectives (p. 58)

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



schema


The response returns the following as the HTTP body.

schema (p. 58)

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

For more information, see the GraphQL SDL documentation.



http://graphql.org/learn/schema/


GraphQLSchemaException

The GraphQL schema is not valid.











https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/GetIntrospectionSchema

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/GetIntrospectionSchema

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetIntrospectionSchema

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/GetIntrospectionSchema

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetIntrospectionSchema

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/GetIntrospectionSchema

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetIntrospectionSchema

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetIntrospectionSchema

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetIntrospectionSchema

AWS AppSync API ReferenceGetResolver

GetResolverRetrieves a Resolver object.

Request SyntaxGET /v1/apis/apiId/types/typeName/resolvers/fieldName HTTP/1.1


apiId (p. 60)

The API ID.

Required: YesfieldName (p. 60)





The resolver type name.



Required: Yes



{ "resolver": { "cachingConfig": { "cachingKeys": [ "string" ], "ttl": number }, "dataSourceName": "string", "fieldName": "string", "kind": "string", "pipelineConfig": {



"functions": [ "string" ] }, "requestMappingTemplate": "string", "resolverArn": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } }, "typeName": "string" }}



resolver (p. 60)

The Resolver object.











• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++


https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/GetResolver

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/GetResolver

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetResolver


• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/GetResolver

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetResolver

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/GetResolver

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetResolver

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetResolver

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetResolver

AWS AppSync API ReferenceGetSchemaCreationStatus

GetSchemaCreationStatusRetrieves the current status of a schema creation operation.

Request SyntaxGET /v1/apis/apiId/schemacreation HTTP/1.1


apiId (p. 63)

The API ID.

Required: Yes



{ "details": "string", "status": "string"}



details (p. 63)

Detailed information about the status of the schema creation operation.

Type: Stringstatus (p. 63)

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

Type: String

Valid Values: PROCESSING | ACTIVE | DELETING | FAILED | SUCCESS |NOT_APPLICABLE




BadRequestException












https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/GetSchemaCreationStatus

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/GetSchemaCreationStatus

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetSchemaCreationStatus

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/GetSchemaCreationStatus

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetSchemaCreationStatus

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/GetSchemaCreationStatus

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetSchemaCreationStatus

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetSchemaCreationStatus

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetSchemaCreationStatus

AWS AppSync API ReferenceGetType

GetTypeRetrieves a Type object.

Request SyntaxGET /v1/apis/apiId/types/typeName?format=format HTTP/1.1


apiId (p. 65)

The API ID.

Required: Yes

format (p. 65)



Required: Yes

typeName (p. 65)

The type name.



Required: Yes



{ "type": { "arn": "string", "definition": "string", "description": "string", "format": "string", "name": "string" }}





type (p. 65)

The Type object.



BadRequestException












• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript


https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/GetType

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/GetType

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetType

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/GetType

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetType

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/GetType


• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetType

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetType

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetType

AWS AppSync API ReferenceListApiKeys

ListApiKeysLists the API keys for a given API.

NoteAPI keys are deleted automatically 60 days after they expire. However, they may still be includedin the response until they have actually been deleted. You can safely call DeleteApiKey tomanually delete a key before it's automatically deleted.

Request SyntaxGET /v1/apis/apiId/apikeys?maxResults=maxResults&nextToken=nextToken HTTP/1.1


apiId (p. 68)

The API ID.

Required: YesmaxResults (p. 68)

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

Valid Range: Minimum value of 0. Maximum value of 25.nextToken (p. 68)

An identifier that was returned from the previous call to this operation, which can be used to returnthe next set of items in the list.


Pattern: [\\S]+



{ "apiKeys": [ { "deletes": number, "description": "string", "expires": number, "id": "string" } ], "nextToken": "string"



}



apiKeys (p. 68)

The ApiKey objects.

Type: Array of ApiKey (p. 129) objectsnextToken (p. 68)

An identifier to be passed in the next request to this operation to return the next set of items in thelist.

Type: String


Pattern: [\\S]+


BadRequestException










• AWS Command Line Interface


https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/ListApiKeys


• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/ListApiKeys

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListApiKeys

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/ListApiKeys

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListApiKeys

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/ListApiKeys

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListApiKeys

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListApiKeys

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListApiKeys

AWS AppSync API ReferenceListDataSources

ListDataSourcesLists the data sources for a given API.

Request SyntaxGET /v1/apis/apiId/datasources?maxResults=maxResults&nextToken=nextToken HTTP/1.1


apiId (p. 71)

The API ID.






Pattern: [\\S]+



{ "dataSources": [ { "dataSourceArn": "string", "description": "string", "dynamodbConfig": { "awsRegion": "string", "deltaSyncConfig": { "baseTableTTL": number, "deltaSyncTableName": "string", "deltaSyncTableTTL": number }, "tableName": "string", "useCallerCredentials": boolean, "versioned": boolean



}, "elasticsearchConfig": { "awsRegion": "string", "endpoint": "string" }, "httpConfig": { "authorizationConfig": { "authorizationType": "string", "awsIamConfig": { "signingRegion": "string", "signingServiceName": "string" } }, "endpoint": "string" }, "lambdaConfig": { "lambdaFunctionArn": "string" }, "name": "string", "relationalDatabaseConfig": { "rdsHttpEndpointConfig": { "awsRegion": "string", "awsSecretStoreArn": "string", "databaseName": "string", "dbClusterIdentifier": "string", "schema": "string" }, "relationalDatabaseSourceType": "string" }, "serviceRoleArn": "string", "type": "string" } ], "nextToken": "string"}



dataSources (p. 71)

The DataSource objects.

Type: Array of DataSource (p. 135) objectsnextToken (p. 71)


Type: String


Pattern: [\\S]+




BadRequestException












https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/ListDataSources

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/ListDataSources

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListDataSources

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/ListDataSources

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListDataSources

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/ListDataSources

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListDataSources

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListDataSources

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListDataSources

AWS AppSync API ReferenceListFunctions

ListFunctionsList multiple functions.

Request SyntaxGET /v1/apis/apiId/functions?maxResults=maxResults&nextToken=nextToken HTTP/1.1


apiId (p. 74)

The GraphQL API ID.






Pattern: [\\S]+



{ "functions": [ { "dataSourceName": "string", "description": "string", "functionArn": "string", "functionId": "string", "functionVersion": "string", "name": "string", "requestMappingTemplate": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string",



"lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } } } ], "nextToken": "string"}



functions (p. 74)

A list of Function objects.

Type: Array of FunctionConfiguration (p. 140) objects

nextToken (p. 74)


Type: String


Pattern: [\\S]+


BadRequestException



InternalFailureException



NotFoundException



UnauthorizedException








https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/ListFunctions

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/ListFunctions

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListFunctions

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/ListFunctions

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListFunctions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/ListFunctions

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListFunctions

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListFunctions

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListFunctions

AWS AppSync API ReferenceListGraphqlApis

ListGraphqlApisLists your GraphQL APIs.

Request SyntaxGET /v1/apis?maxResults=maxResults&nextToken=nextToken HTTP/1.1


maxResults (p. 77)


Valid Range: Minimum value of 0. Maximum value of 25.

nextToken (p. 77)



Pattern: [\\S]+



{ "graphqlApis": [ { "additionalAuthenticationProviders": [ { "authenticationType": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "userPoolId": "string" } } ],



"apiId": "string", "arn": "string", "authenticationType": "string", "logConfig": { "cloudWatchLogsRoleArn": "string", "excludeVerboseContent": boolean, "fieldLogLevel": "string" }, "name": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "tags": { "string" : "string" }, "uris": { "string" : "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string" }, "wafWebAclArn": "string", "xrayEnabled": boolean } ], "nextToken": "string"}



graphqlApis (p. 77)

The GraphqlApi objects.

Type: Array of GraphqlApi (p. 142) objects

nextToken (p. 77)


Type: String


Pattern: [\\S]+




BadRequestException










https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/ListGraphqlApis

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/ListGraphqlApis

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListGraphqlApis

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/ListGraphqlApis

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListGraphqlApis

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/ListGraphqlApis

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListGraphqlApis

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListGraphqlApis

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListGraphqlApis

AWS AppSync API ReferenceListResolvers

ListResolversLists the resolvers for a given API and type.

Request SyntaxGET /v1/apis/apiId/types/typeName/resolvers?maxResults=maxResults&nextToken=nextToken HTTP/1.1


apiId (p. 80)

The API ID.






Pattern: [\\S]+typeName (p. 80)

The type name.

Required: Yes



{ "nextToken": "string", "resolvers": [ { "cachingConfig": { "cachingKeys": [ "string" ], "ttl": number



}, "dataSourceName": "string", "fieldName": "string", "kind": "string", "pipelineConfig": { "functions": [ "string" ] }, "requestMappingTemplate": "string", "resolverArn": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } }, "typeName": "string" } ]}



nextToken (p. 80)


Type: String


Pattern: [\\S]+resolvers (p. 80)

The Resolver objects.

Type: Array of Resolver (p. 152) objects


BadRequestException







NotFoundException








https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/ListResolvers

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/ListResolvers

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListResolvers

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/ListResolvers

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListResolvers

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/ListResolvers

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListResolvers

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListResolvers

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListResolvers

AWS AppSync API ReferenceListResolversByFunction

ListResolversByFunctionList the resolvers that are associated with a specific function.

Request SyntaxGET /v1/apis/apiId/functions/functionId/resolvers?maxResults=maxResults&nextToken=nextToken HTTP/1.1


apiId (p. 83)

The API ID.


The Function ID.




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


Pattern: [\\S]+



{ "nextToken": "string", "resolvers": [ { "cachingConfig": { "cachingKeys": [ "string" ], "ttl": number }, "dataSourceName": "string",



"fieldName": "string", "kind": "string", "pipelineConfig": { "functions": [ "string" ] }, "requestMappingTemplate": "string", "resolverArn": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } }, "typeName": "string" } ]}



nextToken (p. 83)

An identifier that can be used to return the next set of items in the list.

Type: String


Pattern: [\\S]+resolvers (p. 83)

The list of resolvers.

Type: Array of Resolver (p. 152) objects


BadRequestException














https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/ListResolversByFunction

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/ListResolversByFunction

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListResolversByFunction

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/ListResolversByFunction

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListResolversByFunction

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/ListResolversByFunction

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListResolversByFunction

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListResolversByFunction

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListResolversByFunction

AWS AppSync API ReferenceListTagsForResource

ListTagsForResourceLists the tags for a resource.

Request SyntaxGET /v1/tags/resourceArn HTTP/1.1


resourceArn (p. 86)

The GraphqlApi ARN.


Pattern: ^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\d{12}:apis/[0-9A-Za-z_-]{26}$

Required: Yes



{ "tags": { "string" : "string" }}



tags (p. 86)

A TagMap object.

























https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/ListTagsForResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListTagsForResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListTagsForResource

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListTagsForResource

AWS AppSync API ReferenceListTypes

ListTypesLists the types for a given API.

Request SyntaxGET /v1/apis/apiId/types?format=format&maxResults=maxResults&nextToken=nextToken HTTP/1.1


apiId (p. 88)

The API ID.









Pattern: [\\S]+



{ "nextToken": "string", "types": [ { "arn": "string", "definition": "string", "description": "string",



"format": "string", "name": "string" } ]}



nextToken (p. 88)


Type: String


Pattern: [\\S]+types (p. 88)

The Type objects.

Type: Array of Type (p. 155) objects


BadRequestException
















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/ListTypes

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/ListTypes

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListTypes

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/ListTypes

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListTypes

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/ListTypes

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListTypes

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListTypes

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListTypes

AWS AppSync API ReferenceStartSchemaCreation

StartSchemaCreationAdds a new schema to your GraphQL API.

This operation is asynchronous. Use GetSchemaCreationStatus (p. 63) to determine when it hascompleted.

Request SyntaxPOST /v1/apis/apiId/schemacreation HTTP/1.1Content-type: application/json

{ "definition": blob}


apiId (p. 91)

The API ID.

Required: Yes


definition (p. 91)

The schema definition, in GraphQL schema language format.

Type: Base64-encoded binary data object

Required: Yes


{ "status": "string"}





status (p. 91)

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

Type: String

Valid Values: PROCESSING | ACTIVE | DELETING | FAILED | SUCCESS |NOT_APPLICABLE


BadRequestException












• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python


https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/StartSchemaCreation

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/StartSchemaCreation

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/StartSchemaCreation

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/StartSchemaCreation

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/StartSchemaCreation

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/StartSchemaCreation

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/StartSchemaCreation

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/StartSchemaCreation


• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/StartSchemaCreation

AWS AppSync API ReferenceTagResource

TagResourceTags a resource with user-supplied tags.

Request SyntaxPOST /v1/tags/resourceArn HTTP/1.1Content-type: application/json

{ "tags": { "string" : "string" }}


resourceArn (p. 94)

The GraphqlApi ARN.



Required: Yes


tags (p. 94)

A TagMap object.






Required: Yes






















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/TagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/TagResource

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/TagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/TagResource

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/TagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/TagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/TagResource

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/TagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/TagResource



AWS AppSync API ReferenceUntagResource

UntagResourceUntags a resource.

Request SyntaxDELETE /v1/tags/resourceArn?tagKeys=tagKeys HTTP/1.1


resourceArn (p. 97)

The GraphqlApi ARN.



Required: YestagKeys (p. 97)

A list of TagKey objects.

Array Members: Minimum number of 1 item. Maximum number of 50 items.


Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Required: Yes























https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/UntagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/UntagResource

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UntagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/UntagResource

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UntagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/UntagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UntagResource

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UntagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UntagResource

AWS AppSync API ReferenceUpdateApiCache

UpdateApiCacheUpdates the cache for the GraphQL API.

Request SyntaxPOST /v1/apis/apiId/ApiCaches/update HTTP/1.1Content-type: application/json

{ "apiCachingBehavior": "string", "ttl": number, "type": "string"}


apiId (p. 99)

The GraphQL API Id.

Required: Yes


apiCachingBehavior (p. 99)


Type: String


Required: Yesttl (p. 99)



Type: Long

Required: Yestype (p. 99)

The cache instance type. Valid values are• SMALL

• MEDIUM



• LARGE

• XLARGE

• LARGE_2X

• LARGE_4X




Type: String


Required: Yes


{ "apiCache": { "apiCachingBehavior": "string", "atRestEncryptionEnabled": boolean, "status": "string", "transitEncryptionEnabled": boolean, "ttl": number, "type": "string" }}



apiCache (p. 100)






BadRequestException














https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/UpdateApiCache

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/UpdateApiCache

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateApiCache

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/UpdateApiCache

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateApiCache

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/UpdateApiCache

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateApiCache

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateApiCache

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateApiCache

AWS AppSync API ReferenceUpdateApiKey

UpdateApiKeyUpdates an API key. The key can be updated while it is not deleted.

Request SyntaxPOST /v1/apis/apiId/apikeys/id HTTP/1.1Content-type: application/json

{ "description": "string", "expires": number}


apiId (p. 102)

The ID for the GraphQL API.

Required: Yesid (p. 102)

The API key ID.

Required: Yes


description (p. 102)


Type: String

Required: Noexpires (p. 102)

The time from update time after which the API key expires. The date is represented as seconds sincethe epoch. For more information, see ApiKey (p. 129).

Type: Long

Required: No




{ "apiKey": { "deletes": number, "description": "string", "expires": number, "id": "string" }}



apiKey (p. 102)

The API key.

Type: ApiKey (p. 129) object


ApiKeyValidityOutOfBoundsException

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

















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/UpdateApiKey

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/UpdateApiKey

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateApiKey

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/UpdateApiKey

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateApiKey

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/UpdateApiKey

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateApiKey

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateApiKey

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateApiKey

AWS AppSync API ReferenceUpdateDataSource

UpdateDataSourceUpdates a DataSource object.

Request SyntaxPOST /v1/apis/apiId/datasources/name HTTP/1.1Content-type: application/json

{ "description": "string", "dynamodbConfig": { "awsRegion": "string", "deltaSyncConfig": { "baseTableTTL": number, "deltaSyncTableName": "string", "deltaSyncTableTTL": number }, "tableName": "string", "useCallerCredentials": boolean, "versioned": boolean }, "elasticsearchConfig": { "awsRegion": "string", "endpoint": "string" }, "httpConfig": { "authorizationConfig": { "authorizationType": "string", "awsIamConfig": { "signingRegion": "string", "signingServiceName": "string" } }, "endpoint": "string" }, "lambdaConfig": { "lambdaFunctionArn": "string" }, "relationalDatabaseConfig": { "rdsHttpEndpointConfig": { "awsRegion": "string", "awsSecretStoreArn": "string", "databaseName": "string", "dbClusterIdentifier": "string", "schema": "string" }, "relationalDatabaseSourceType": "string" }, "serviceRoleArn": "string", "type": "string"}


apiId (p. 105)

The API ID.




The new name for the data source.



Required: Yes


description (p. 105)

The new description for the data source.

Type: String

Required: NodynamodbConfig (p. 105)

The new Amazon DynamoDB configuration.


Required: NoelasticsearchConfig (p. 105)

The new Elasticsearch Service configuration.


Required: NohttpConfig (p. 105)

The new HTTP endpoint configuration.


Required: NolambdaConfig (p. 105)

The new AWS Lambda configuration.


Required: NorelationalDatabaseConfig (p. 105)

The new relational database configuration.


Required: No



serviceRoleArn (p. 105)

The new service role ARN for the data source.

Type: String

Required: Notype (p. 105)

The new data source type.

Type: String


Required: Yes


{ "dataSource": { "dataSourceArn": "string", "description": "string", "dynamodbConfig": { "awsRegion": "string", "deltaSyncConfig": { "baseTableTTL": number, "deltaSyncTableName": "string", "deltaSyncTableTTL": number }, "tableName": "string", "useCallerCredentials": boolean, "versioned": boolean }, "elasticsearchConfig": { "awsRegion": "string", "endpoint": "string" }, "httpConfig": { "authorizationConfig": { "authorizationType": "string", "awsIamConfig": { "signingRegion": "string", "signingServiceName": "string" } }, "endpoint": "string" }, "lambdaConfig": { "lambdaFunctionArn": "string" }, "name": "string", "relationalDatabaseConfig": { "rdsHttpEndpointConfig": { "awsRegion": "string", "awsSecretStoreArn": "string", "databaseName": "string", "dbClusterIdentifier": "string",



"schema": "string" }, "relationalDatabaseSourceType": "string" }, "serviceRoleArn": "string", "type": "string" }}



dataSource (p. 107)

The updated DataSource object.



BadRequestException
















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/UpdateDataSource

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/UpdateDataSource

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateDataSource

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/UpdateDataSource

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateDataSource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/UpdateDataSource

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateDataSource

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateDataSource

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateDataSource

AWS AppSync API ReferenceUpdateFunction

UpdateFunctionUpdates a Function object.

Request SyntaxPOST /v1/apis/apiId/functions/functionId HTTP/1.1Content-type: application/json

{ "dataSourceName": "string", "description": "string", "functionVersion": "string", "name": "string", "requestMappingTemplate": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } }}


apiId (p. 110)

The GraphQL API ID.


The function ID.



Required: Yes


dataSourceName (p. 110)

The Function DataSource name.

Type: String





Required: Yesdescription (p. 110)


Type: String

Required: NofunctionVersion (p. 110)

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

Type: String


The Function name.

Type: String



Required: YesrequestMappingTemplate (p. 110)


Type: String


Required: NoresponseMappingTemplate (p. 110)

The Function request mapping template.

Type: String






Required: No




Content-type: application/json

{ "functionConfiguration": { "dataSourceName": "string", "description": "string", "functionArn": "string", "functionId": "string", "functionVersion": "string", "name": "string", "requestMappingTemplate": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } } }}





















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/UpdateFunction

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/UpdateFunction

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateFunction

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/UpdateFunction

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateFunction

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/UpdateFunction

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateFunction

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateFunction

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateFunction

AWS AppSync API ReferenceUpdateGraphqlApi

UpdateGraphqlApiUpdates a GraphqlApi object.

Request Syntax

POST /v1/apis/apiId HTTP/1.1Content-type: application/json

{ "additionalAuthenticationProviders": [ { "authenticationType": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "userPoolId": "string" } } ], "authenticationType": "string", "logConfig": { "cloudWatchLogsRoleArn": "string", "excludeVerboseContent": boolean, "fieldLogLevel": "string" }, "name": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string" }, "xrayEnabled": boolean}


apiId (p. 114)

The API ID.

Required: Yes




additionalAuthenticationProviders (p. 114)



Required: NoauthenticationType (p. 114)

The new authentication type for the GraphqlApi object.

Type: String


Required: NologConfig (p. 114)

The Amazon CloudWatch Logs configuration for the GraphqlApi object.



The new name for the GraphqlApi object.

Type: String

Required: YesopenIDConnectConfig (p. 114)

The OpenID Connect configuration for the GraphqlApi object.


Required: NouserPoolConfig (p. 114)

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


Required: NoxrayEnabled (p. 114)

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

Type: Boolean

Required: No




Content-type: application/json

{ "graphqlApi": { "additionalAuthenticationProviders": [ { "authenticationType": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "userPoolId": "string" } } ], "apiId": "string", "arn": "string", "authenticationType": "string", "logConfig": { "cloudWatchLogsRoleArn": "string", "excludeVerboseContent": boolean, "fieldLogLevel": "string" }, "name": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "tags": { "string" : "string" }, "uris": { "string" : "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string" }, "wafWebAclArn": "string", "xrayEnabled": boolean }}



graphqlApi (p. 115)

The updated GraphqlApi object.





















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/UpdateGraphqlApi

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/UpdateGraphqlApi

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateGraphqlApi

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/UpdateGraphqlApi

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateGraphqlApi

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/UpdateGraphqlApi

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateGraphqlApi

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateGraphqlApi

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateGraphqlApi

AWS AppSync API ReferenceUpdateResolver

UpdateResolverUpdates a Resolver object.

Request SyntaxPOST /v1/apis/apiId/types/typeName/resolvers/fieldName HTTP/1.1Content-type: application/json

{ "cachingConfig": { "cachingKeys": [ "string" ], "ttl": number }, "dataSourceName": "string", "kind": "string", "pipelineConfig": { "functions": [ "string" ] }, "requestMappingTemplate": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } }}


apiId (p. 118)

The API ID.

Required: Yes

fieldName (p. 118)

The new field name.



Required: Yes

typeName (p. 118)

The new type name.



Required: Yes




cachingConfig (p. 118)



Required: NodataSourceName (p. 118)

The new data source name.

Type: String



Required: Nokind (p. 118)



Type: String


Required: NopipelineConfig (p. 118)

The PipelineConfig.


Required: NorequestMappingTemplate (p. 118)

The new request mapping template.

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

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

Type: String


Required: No



responseMappingTemplate (p. 118)

The new response mapping template.

Type: String





Required: No


{ "resolver": { "cachingConfig": { "cachingKeys": [ "string" ], "ttl": number }, "dataSourceName": "string", "fieldName": "string", "kind": "string", "pipelineConfig": { "functions": [ "string" ] }, "requestMappingTemplate": "string", "resolverArn": "string", "responseMappingTemplate": "string", "syncConfig": { "conflictDetection": "string", "conflictHandler": "string", "lambdaConflictHandlerConfig": { "lambdaConflictHandlerArn": "string" } }, "typeName": "string" }}



resolver (p. 120)

The updated Resolver object.

















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/UpdateResolver

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/UpdateResolver

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateResolver

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/UpdateResolver

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateResolver

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/UpdateResolver

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateResolver

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateResolver

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateResolver

AWS AppSync API ReferenceUpdateType

UpdateTypeUpdates a Type object.

Request Syntax

POST /v1/apis/apiId/types/typeName HTTP/1.1Content-type: application/json

{ "definition": "string", "format": "string"}


apiId (p. 122)

The API ID.

Required: Yes

typeName (p. 122)

The new type name.



Required: Yes


definition (p. 122)

The new definition.

Type: String

Required: No

format (p. 122)

The new type format: SDL or JSON.

Type: String


Required: Yes




{ "type": { "arn": "string", "definition": "string", "description": "string", "format": "string", "name": "string" }}



type (p. 123)

The updated Type object.



BadRequestException
















https://docs.aws.amazon.com/goto/aws-cli/appsync-2017-07-25/UpdateType

https://docs.aws.amazon.com/goto/DotNetSDKV3/appsync-2017-07-25/UpdateType

https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateType

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/UpdateType

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateType

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/appsync-2017-07-25/UpdateType

https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateType

https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateType

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateType


Data TypesThe AWS AppSync API contains several data types that various actions use. This section describes eachdata type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• AdditionalAuthenticationProvider (p. 126)• ApiCache (p. 127)• ApiKey (p. 129)• AuthorizationConfig (p. 131)• AwsIamConfig (p. 132)• CachingConfig (p. 133)• CognitoUserPoolConfig (p. 134)• DataSource (p. 135)• DeltaSyncConfig (p. 137)• DynamodbDataSourceConfig (p. 138)• ElasticsearchDataSourceConfig (p. 139)• FunctionConfiguration (p. 140)• GraphqlApi (p. 142)• HttpDataSourceConfig (p. 144)• LambdaConflictHandlerConfig (p. 145)• LambdaDataSourceConfig (p. 146)• LogConfig (p. 147)• OpenIDConnectConfig (p. 148)• PipelineConfig (p. 149)• RdsHttpEndpointConfig (p. 150)• RelationalDatabaseDataSourceConfig (p. 151)• Resolver (p. 152)• SyncConfig (p. 154)• Type (p. 155)• UserPoolConfig (p. 157)


AWS AppSync API ReferenceAdditionalAuthenticationProvider

AdditionalAuthenticationProviderDescribes an additional authentication provider.

ContentsauthenticationType

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

Type: String


Required: NoopenIDConnectConfig



Required: NouserPoolConfig


Type: CognitoUserPoolConfig (p. 134) object

Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/AdditionalAuthenticationProvider

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/AdditionalAuthenticationProvider

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/AdditionalAuthenticationProvider

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/AdditionalAuthenticationProvider

AWS AppSync API ReferenceApiCache

ApiCacheThe ApiCache object.

ContentsapiCachingBehavior


Type: String


Required: NoatRestEncryptionEnabled

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

Type: Boolean

Required: Nostatus

The cache instance status.• AVAILABLE: The instance is available for use.• CREATING: The instance is currently creating.• DELETING: The instance is currently deleting.• MODIFYING: The instance is currently modifying.• FAILED: The instance has failed creation.

Type: String

Valid Values: AVAILABLE | CREATING | DELETING | MODIFYING | FAILED

Required: NotransitEncryptionEnabled

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

Type: Boolean

Required: Nottl



Type: Long

Required: Notype

The cache instance type. Valid values are



• SMALL

• MEDIUM

• LARGE

• XLARGE

• LARGE_2X

• LARGE_4X




Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ApiCache

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/ApiCache

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ApiCache

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ApiCache

AWS AppSync API ReferenceApiKey

ApiKeyDescribes an API key.

Customers invoke AWS AppSync GraphQL API operations with API keys as an identity mechanism. Thereare two key versions:

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

• ListApiKeys returns the expiration time in milliseconds.• CreateApiKey returns the expiration time in milliseconds.• UpdateApiKey is not available for this key version.• DeleteApiKey deletes the item from the table.• Expiration is stored in 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-timeaction, we will delete these keys from the table after February 21, 2018.

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

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

expiration time in seconds.• UpdateApiKey returns the expiration time and and deletion time in seconds and accepts a user-

provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration time.Key expiration time can be updated while the key is not deleted.

• DeleteApiKey deletes the item from the table.• 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.• Deletion is stored in Amazon DynamoDB as seconds. The key will be deleted after deletion time.

Contentsdeletes

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

Type: Long

Required: Nodescription


Type: String

Required: Noexpires

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



Type: Long

Required: Noid

The API key ID.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ApiKey

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/ApiKey

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ApiKey

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ApiKey

AWS AppSync API ReferenceAuthorizationConfig

AuthorizationConfigThe authorization config in case the HTTP endpoint requires authorization.

ContentsauthorizationType

The authorization type required by the HTTP endpoint.• AWS_IAM: The authorization type is Sigv4.

Type: String

Valid Values: AWS_IAM

Required: YesawsIamConfig

The AWS IAM settings.

Type: AwsIamConfig (p. 132) object

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/AuthorizationConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/AuthorizationConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/AuthorizationConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/AuthorizationConfig

AWS AppSync API ReferenceAwsIamConfig

AwsIamConfigThe AWS IAM configuration.

ContentssigningRegion

The signing region for AWS IAM authorization.

Type: String

Required: NosigningServiceName

The signing service name for AWS IAM authorization.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/AwsIamConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/AwsIamConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/AwsIamConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/AwsIamConfig

AWS AppSync API ReferenceCachingConfig

CachingConfigThe caching configuration for a resolver that has caching enabled.

ContentscachingKeys

The caching keys for a resolver that has caching enabled.

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

Type: Array of strings

Required: Nottl

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


Type: Long

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CachingConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/CachingConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CachingConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CachingConfig

AWS AppSync API ReferenceCognitoUserPoolConfig

CognitoUserPoolConfigDescribes an Amazon Cognito user pool configuration.

ContentsappIdClientRegex

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

Type: String

Required: NoawsRegion

The AWS Region in which the user pool was created.

Type: String

Required: YesuserPoolId

The user pool ID.

Type: String

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CognitoUserPoolConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/CognitoUserPoolConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CognitoUserPoolConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CognitoUserPoolConfig

AWS AppSync API ReferenceDataSource

DataSourceDescribes a data source.

ContentsdataSourceArn

The data source ARN.

Type: String


The description of the data source.

Type: String

Required: NodynamodbConfig

Amazon DynamoDB settings.


Required: NoelasticsearchConfig

Amazon Elasticsearch Service settings.


Required: NohttpConfig

HTTP endpoint settings.


Required: NolambdaConfig

AWS Lambda settings.


Required: Noname


Type: String





Required: NorelationalDatabaseConfig

Relational database settings.


Required: NoserviceRoleArn

The AWS IAM service role ARN for the data source. The system assumes this role when accessing thedata source.

Type: String

Required: Notype

The type of the data source.• AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.• AMAZON_ELASTICSEARCH: The data source is an Amazon Elasticsearch Service domain.• AWS_LAMBDA: The data source is an AWS Lambda function.• NONE: 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 ortriggering a subscription to be invoked from a mutation.

• HTTP: The data source is an HTTP endpoint.• RELATIONAL_DATABASE: The data source is a relational database.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DataSource

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/DataSource

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DataSource

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DataSource

AWS AppSync API ReferenceDeltaSyncConfig

DeltaSyncConfigDescribes a Delta Sync configuration.

ContentsbaseTableTTL

The number of minutes an Item is stored in the datasource.

Type: Long

Required: NodeltaSyncTableName

The Delta Sync table name.

Type: String

Required: NodeltaSyncTableTTL

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

Type: Long

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeltaSyncConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/DeltaSyncConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeltaSyncConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeltaSyncConfig

AWS AppSync API ReferenceDynamodbDataSourceConfig

DynamodbDataSourceConfigDescribes an Amazon DynamoDB data source configuration.

ContentsawsRegion

The AWS Region.

Type: String

Required: YesdeltaSyncConfig

The DeltaSyncConfig for a versioned datasource.

Type: DeltaSyncConfig (p. 137) object

Required: NotableName

The table name.

Type: String

Required: YesuseCallerCredentials

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

Type: Boolean

Required: Noversioned

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

Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DynamodbDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/DynamodbDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DynamodbDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DynamodbDataSourceConfig

AWS AppSync API ReferenceElasticsearchDataSourceConfig

ElasticsearchDataSourceConfigDescribes an Elasticsearch data source configuration.

ContentsawsRegion

The AWS Region.

Type: String

Required: Yesendpoint

The endpoint.

Type: String

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ElasticsearchDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/ElasticsearchDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ElasticsearchDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ElasticsearchDataSourceConfig

AWS AppSync API ReferenceFunctionConfiguration

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

ContentsdataSourceName

The name of the DataSource.

Type: String





Type: String

Required: NofunctionArn

The ARN of the Function object.

Type: String

Required: NofunctionId

A unique ID representing the Function object.

Type: String

Required: NofunctionVersion

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

Type: String

Required: Noname

The name of the Function object.

Type: String



Required: No



requestMappingTemplate


Type: String


Required: NoresponseMappingTemplate

The Function response mapping template.

Type: String


Required: NosyncConfig




Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/FunctionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/FunctionConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/FunctionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/FunctionConfiguration

AWS AppSync API ReferenceGraphqlApi

GraphqlApiDescribes a GraphQL API.

ContentsadditionalAuthenticationProviders



Required: NoapiId

The API ID.

Type: String

Required: Noarn

The ARN.

Type: String

Required: NoauthenticationType

The authentication type.

Type: String


Required: NologConfig

The Amazon CloudWatch Logs configuration.


Required: Noname

The API name.

Type: String



Required: NoopenIDConnectConfig





Required: Notags

The tags.






Required: Nouris

The URIs.


Required: NouserPoolConfig



Required: NowafWebAclArn

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

Type: String

Required: NoxrayEnabled

A flag representing whether X-Ray tracing is enabled for this GraphqlApi.

Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GraphqlApi

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/GraphqlApi

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GraphqlApi

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GraphqlApi

AWS AppSync API ReferenceHttpDataSourceConfig

HttpDataSourceConfigDescribes an HTTP data source configuration.

ContentsauthorizationConfig

The authorization config in case the HTTP endpoint requires authorization.

Type: AuthorizationConfig (p. 131) object

Required: Noendpoint

The HTTP URL endpoint. You can either specify the domain name or IP, and port combination, andthe URL scheme must be HTTP or HTTPS. If the port is not specified, AWS AppSync uses the defaultport 80 for the HTTP endpoint and port 443 for HTTPS endpoints.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/HttpDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/HttpDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/HttpDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/HttpDataSourceConfig

AWS AppSync API ReferenceLambdaConflictHandlerConfig

LambdaConflictHandlerConfigThe LambdaConflictHandlerConfig object when configuring LAMBDA as the Conflict Handler.

ContentslambdaConflictHandlerArn

The Arn for the Lambda function to use as the Conflict Handler.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/LambdaConflictHandlerConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/LambdaConflictHandlerConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/LambdaConflictHandlerConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/LambdaConflictHandlerConfig

AWS AppSync API ReferenceLambdaDataSourceConfig

LambdaDataSourceConfigDescribes an AWS Lambda data source configuration.

ContentslambdaFunctionArn

The ARN for the Lambda function.

Type: String

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/LambdaDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/LambdaDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/LambdaDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/LambdaDataSourceConfig

AWS AppSync API ReferenceLogConfig

LogConfigThe CloudWatch Logs configuration.

ContentscloudWatchLogsRoleArn

The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in youraccount.

Type: String

Required: YesexcludeVerboseContent

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

Type: Boolean

Required: NofieldLogLevel

The field logging level. Values can be NONE, ERROR, or ALL.• NONE: No field-level logs are captured.• ERROR: Logs the following information only for the fields that are in error:

• The error section in the server response.• Field-level errors.• The generated request/response functions that got resolved for error fields.

• ALL: The following information is logged for all fields in the query:• Field-level tracing information.• The generated request/response functions that got resolved for each field.

Type: String

Valid Values: NONE | ERROR | ALL

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/LogConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/LogConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/LogConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/LogConfig

AWS AppSync API ReferenceOpenIDConnectConfig

OpenIDConnectConfigDescribes an OpenID Connect configuration.

ContentsauthTTL

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

Type: Long

Required: NoclientId

The client identifier of the Relying party at the OpenID identity provider. This identifier is typicallyobtained when the Relying party is registered with the OpenID identity provider. You can specify aregular expression so the AWS AppSync can validate against multiple client identifiers at a time.

Type: String

Required: NoiatTTL

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

Type: Long

Required: Noissuer

The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactlymatch the value of iss in the ID token.

Type: String

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/OpenIDConnectConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/OpenIDConnectConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/OpenIDConnectConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/OpenIDConnectConfig

AWS AppSync API ReferencePipelineConfig

PipelineConfigThe pipeline configuration for a resolver of kind PIPELINE.

Contentsfunctions

A list of Function objects.

Type: Array of strings

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/PipelineConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/PipelineConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/PipelineConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/PipelineConfig

AWS AppSync API ReferenceRdsHttpEndpointConfig

RdsHttpEndpointConfigThe Amazon RDS HTTP endpoint configuration.

ContentsawsRegion

AWS Region for RDS HTTP endpoint.

Type: String

Required: NoawsSecretStoreArn

AWS secret store ARN for database credentials.

Type: String

Required: NodatabaseName

Logical database name.

Type: String

Required: NodbClusterIdentifier

Amazon RDS cluster ARN.

Type: String

Required: Noschema

Logical schema name.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/RdsHttpEndpointConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/RdsHttpEndpointConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/RdsHttpEndpointConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/RdsHttpEndpointConfig

AWS AppSync API ReferenceRelationalDatabaseDataSourceConfig

RelationalDatabaseDataSourceConfigDescribes a relational database data source configuration.

ContentsrdsHttpEndpointConfig

Amazon RDS HTTP endpoint settings.

Type: RdsHttpEndpointConfig (p. 150) object

Required: NorelationalDatabaseSourceType

Source type for the relational database.• RDS_HTTP_ENDPOINT: The relational database source type is an Amazon RDS HTTP endpoint.

Type: String

Valid Values: RDS_HTTP_ENDPOINT

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/RelationalDatabaseDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/RelationalDatabaseDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/RelationalDatabaseDataSourceConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/RelationalDatabaseDataSourceConfig

AWS AppSync API ReferenceResolver

ResolverDescribes a resolver.

ContentscachingConfig



Required: NodataSourceName

The resolver data source name.

Type: String



Required: NofieldName


Type: String



Required: Nokind



Type: String


Required: NopipelineConfig

The PipelineConfig.


Required: No



requestMappingTemplate

The request mapping template.

Type: String


Required: NoresolverArn

The resolver ARN.

Type: String

Required: NoresponseMappingTemplate

The response mapping template.

Type: String


Required: NosyncConfig



Required: NotypeName

The resolver type name.

Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/Resolver

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/Resolver

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/Resolver

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/Resolver

AWS AppSync API ReferenceSyncConfig

SyncConfigDescribes a Sync configuration for a resolver.

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

ContentsconflictDetection

The Conflict Detection strategy to use.• VERSION: Detect conflicts based on object versions for this resolver.• NONE: Do not detect conflicts when executing this resolver.

Type: String

Valid Values: VERSION | NONE

Required: NoconflictHandler

The Conflict Resolution strategy to perform in the event of a conflict.• OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions do not

match the latest version at the server.• AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.• LAMBDA: Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.

Type: String

Valid Values: OPTIMISTIC_CONCURRENCY | LAMBDA | AUTOMERGE | NONE

Required: NolambdaConflictHandlerConfig

The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

Type: LambdaConflictHandlerConfig (p. 145) object

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/SyncConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/SyncConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/SyncConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/SyncConfig

AWS AppSync API ReferenceType

TypeDescribes a type.

Contentsarn

The type ARN.

Type: String

Required: Nodefinition

The type definition.

Type: String


The type description.

Type: String

Required: Noformat


Type: String


Required: Noname

The type name.

Type: String



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/Type

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/Type

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/Type

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/Type



AWS AppSync API ReferenceUserPoolConfig

UserPoolConfigDescribes an Amazon Cognito user pool configuration.

ContentsappIdClientRegex

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

Type: String

Required: NoawsRegion

The AWS Region in which the user pool was created.

Type: String

Required: YesdefaultAction

The action that you want your GraphQL API to take when a request that uses Amazon Cognito userpool authentication doesn't match the Amazon Cognito user pool configuration.

Type: String

Valid Values: ALLOW | DENY

Required: YesuserPoolId

The user pool ID.

Type: String

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UserPoolConfig

https://docs.aws.amazon.com/goto/SdkForGoV1/appsync-2017-07-25/UserPoolConfig

https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UserPoolConfig

https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UserPoolConfig


Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.


Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is


http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html


not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.


Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.


Type: string

Required: Conditional


http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.


You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.




MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400NotAuthorized

You do not have permission to perform this action.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.



Documents

AWS AppSync - API Reference€¦ · The GraphQL API Id. Required: Yes Request Body The request accepts the following data in JSON format. apiCachingBehavior (p. 4) Caching behavior