AWS AppSync - API Reference

1 AWS AppSyncAPI ReferenceAPI Version 2017-07-25 AWS AppSync API ReferenceAWS AppSync : API ReferenceCopyright 2020 Amazon Web Services, Inc. and/or its affiliates. All rights '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 AppSync API ReferenceTable of ContentsWelcome .. 1 Actions .. 2 CreateApiCache .. 4 Request Syntax .. 4 URI Request Parameters .. 4 Request Body .. 4 Response Syntax .. 5 Response Elements .. 5 Errors .. 6 See 6 CreateApiKey.

2 7 Request Syntax .. 7 URI Request Parameters .. 7 Request Body .. 7 Response Syntax .. 7 Response Elements .. 8 Errors .. 8 See 9 CreateDataSource .. 10 Request Syntax .. 10 URI Request Parameters .. 10 Request Body .. 11 Response Syntax .. 12 Response Elements .. 13 Errors .. 13 See 13 CreateFunction .. 15 Request Syntax .. 15 URI Request Parameters .. 15 Request Body .. 15 Response Syntax .. 16 Response Elements .. 16 Errors .. 17 See 17 CreateGraphqlApi .. 18 Request Syntax .. 18 URI Request Parameters .. 18 Request Body .. 18 Response Syntax .. 20 Response Elements .. 20 Errors .. 21 See 21 CreateResolver .. 22 Request Syntax .. 22 URI Request Parameters .. 22 Request Body .. 22 Response Syntax .. 24 Response Elements.

3 24 Errors .. 25 See 25 CreateType .. 26 Request Syntax .. 26 URI Request Parameters .. 26 Request Body .. 26 API Version 2017-07-25iiiAWS AppSync API ReferenceResponse Syntax .. 26 Response Elements .. 27 Errors .. 27 See 29 Request Syntax .. 29 URI Request Parameters .. 29 Request Body .. 29 Response Syntax .. 29 Response Elements .. 29 Errors .. 29 See 30 DeleteApiKey .. 31 Request Syntax .. 31 URI Request Parameters .. 31 Request Body .. 31 Response Syntax .. 31 Response Elements .. 31 Errors .. 31 See 32 DeleteDataSource .. 33 Request Syntax .. 33 URI Request Parameters .. 33 Request Body .. 33 Response Syntax .. 33 Response Elements .. 33 Errors .. 33 See 34 DeleteFunction .. 35 Request Syntax .. 35 URI Request Parameters.

4 35 Request Body .. 35 Response Syntax .. 35 Response Elements .. 35 Errors .. 35 See 37 Request Syntax .. 37 URI Request Parameters .. 37 Request Body .. 37 Response Syntax .. 37 Response Elements .. 37 Errors .. 37 See 38 DeleteResolver .. 39 Request Syntax .. 39 URI Request Parameters .. 39 Request Body .. 39 Response Syntax .. 39 Response Elements .. 39 Errors .. 39 See 40 DeleteType .. 41 Request Syntax .. 41 URI Request Parameters .. 41 Request Body .. 41 Response Syntax .. 41 API Version 2017-07-25ivAWS AppSync API ReferenceResponse Elements .. 41 Errors .. 41 See 43 Request Syntax .. 43 URI Request Parameters .. 43 Request Body .. 43 Response Syntax .. 43 Response Elements .. 43 Errors .. 43 See 45 Request Syntax.

5 45 URI Request Parameters .. 45 Request Body .. 45 Response Syntax .. 45 Response Elements .. 45 Errors .. 45 See 46 GetDataSource .. 47 Request Syntax .. 47 URI Request Parameters .. 47 Request Body .. 47 Response Syntax .. 47 Response Elements .. 48 Errors .. 48 See 49 GetFunction .. 50 Request Syntax .. 50 URI Request Parameters .. 50 Request Body .. 50 Response Syntax .. 50 Response Elements .. 50 Errors .. 51 See 52 Request Syntax .. 52 URI Request Parameters .. 52 Request Body .. 52 Response Syntax .. 52 Response Elements .. 53 Errors .. 53 See 54 GetIntrospectionSchema .. 55 Request Syntax .. 55 URI Request Parameters .. 55 Request Body .. 55 Response Syntax .. 55 Response Elements .. 55 Errors .. 55 See 56 GetResolver.

6 57 Request Syntax .. 57 URI Request Parameters .. 57 Request Body .. 57 Response Syntax .. 57 Response Elements .. 58 API Version 2017-07-25vAWS AppSync API ReferenceErrors .. 58 See 58 GetSchemaCreationStatus .. 60 Request Syntax .. 60 URI Request Parameters .. 60 Request Body .. 60 Response Syntax .. 60 Response Elements .. 60 Errors .. 61 See 61 GetType .. 62 Request Syntax .. 62 URI Request Parameters .. 62 Request Body .. 62 Response Syntax .. 62 Response Elements .. 62 Errors .. 63 See 63 ListApiKeys .. 64 Request Syntax .. 64 URI Request Parameters .. 64 Request Body .. 64 Response Syntax .. 64 Response Elements .. 65 Errors .. 65 See 65 ListDataSources .. 67 Request Syntax .. 67 URI Request Parameters .. 67 Request Body.

7 67 Response Syntax .. 67 Response Elements .. 68 Errors .. 68 See 69 ListFunctions .. 70 Request Syntax .. 70 URI Request Parameters .. 70 Request Body .. 70 Response Syntax .. 70 Response Elements .. 71 Errors .. 71 See 73 Request Syntax .. 73 URI Request Parameters .. 73 Request Body .. 73 Response Syntax .. 73 Response Elements .. 74 Errors .. 74 See 75 ListResolvers .. 76 Request Syntax .. 76 URI Request Parameters .. 76 Request Body .. 76 Response Syntax .. 76 Response Elements .. 77 Errors .. 77 API Version 2017-07-25viAWS AppSync API ReferenceSee 78 ListResolversByFunction .. 79 Request Syntax .. 79 URI Request Parameters .. 79 Request Body .. 79 Response Syntax .. 79 Response Elements .. 80 Errors .. 80 See 81 ListTagsForResource.

8 82 Request Syntax .. 82 URI Request Parameters .. 82 Request Body .. 82 Response Syntax .. 82 Response Elements .. 82 Errors .. 83 See 83 ListTypes .. 84 Request Syntax .. 84 URI Request Parameters .. 84 Request Body .. 84 Response Syntax .. 84 Response Elements .. 85 Errors .. 85 See 86 StartSchemaCreation .. 87 Request Syntax .. 87 URI Request Parameters .. 87 Request Body .. 87 Response Syntax .. 87 Response Elements .. 87 Errors .. 88 See 88 TagResource .. 90 Request Syntax .. 90 URI Request Parameters .. 90 Request Body .. 90 Response Syntax .. 90 Response Elements .. 90 Errors .. 91 See 91 UntagResource .. 92 Request Syntax .. 92 URI Request Parameters .. 92 Request Body .. 92 Response Syntax .. 92 Response Elements.

9 92 Errors .. 92 See 94 Request Syntax .. 94 URI Request Parameters .. 94 Request Body .. 94 Response Syntax .. 95 Response Elements .. 95 Errors .. 95 See 96 API Version 2017-07-25viiAWS AppSync API ReferenceUpdateApiKey .. 97 Request Syntax .. 97 URI Request Parameters .. 97 Request Body .. 97 Response Syntax .. 97 Response Elements .. 98 Errors .. 98 See 98 UpdateDataSource .. 100 Request Syntax .. 100 URI Request Parameters .. 100 Request Body .. 101 Response Syntax .. 102 Response Elements .. 103 Errors .. 103 See 103 UpdateFunction .. 105 Request Syntax .. 105 URI Request Parameters .. 105 Request Body .. 105 Response Syntax .. 106 Response Elements .. 106 Errors .. 107 See 108 Request Syntax .. 108 URI Request Parameters.

10 108 Request Body .. 108 Response Syntax .. 109 Response Elements .. 110 Errors .. 110 See 111 UpdateResolver .. 112 Request Syntax .. 112 URI Request Parameters .. 112 Request Body .. 112 Response Syntax .. 114 Response Elements .. 114 Errors .. 114 See 115 UpdateType .. 116 Request Syntax .. 116 URI Request Parameters .. 116 Request Body .. 116 Response Syntax .. 116 Response Elements .. 117 Errors .. 117 See 117 Data Types .. 119 AdditionalAuthenticationProvider .. 120 See 121 See 122 ApiKey .. 123 API Version 2017-07-25viiiAWS AppSync API ReferenceSee 125 See 125 AwsIamConfig .. 126 See 127 See 127 CognitoUserPoolConfig .. 128 See 128 DataSource .. 129 See 130 DeltaSyncConfig.