@aws-sdk/client-appsync 3.325.0 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/README.md +2 -2
  2. package/dist-cjs/endpoint/ruleset.js +3 -3
  3. package/dist-cjs/models/models_0.js +5 -1
  4. package/dist-cjs/protocols/Aws_restJson1.js +1 -0
  5. package/dist-es/endpoint/ruleset.js +3 -3
  6. package/dist-es/models/models_0.js +4 -0
  7. package/dist-es/protocols/Aws_restJson1.js +1 -0
  8. package/dist-types/AppSync.d.ts +2 -2
  9. package/dist-types/AppSyncClient.d.ts +2 -2
  10. package/dist-types/commands/AssociateApiCommand.d.ts +15 -3
  11. package/dist-types/commands/CreateApiCacheCommand.d.ts +19 -5
  12. package/dist-types/commands/CreateApiKeyCommand.d.ts +15 -3
  13. package/dist-types/commands/CreateDataSourceCommand.d.ts +63 -5
  14. package/dist-types/commands/CreateDomainNameCommand.d.ts +14 -2
  15. package/dist-types/commands/CreateFunctionCommand.d.ts +34 -4
  16. package/dist-types/commands/CreateGraphqlApiCommand.d.ts +71 -4
  17. package/dist-types/commands/CreateResolverCommand.d.ts +46 -7
  18. package/dist-types/commands/CreateTypeCommand.d.ts +18 -5
  19. package/dist-types/commands/DeleteApiCacheCommand.d.ts +10 -5
  20. package/dist-types/commands/DeleteApiKeyCommand.d.ts +8 -3
  21. package/dist-types/commands/DeleteDataSourceCommand.d.ts +10 -5
  22. package/dist-types/commands/DeleteDomainNameCommand.d.ts +10 -5
  23. package/dist-types/commands/DeleteFunctionCommand.d.ts +8 -3
  24. package/dist-types/commands/DeleteGraphqlApiCommand.d.ts +10 -5
  25. package/dist-types/commands/DeleteResolverCommand.d.ts +10 -5
  26. package/dist-types/commands/DeleteTypeCommand.d.ts +10 -5
  27. package/dist-types/commands/DisassociateApiCommand.d.ts +10 -5
  28. package/dist-types/commands/EvaluateCodeCommand.d.ts +31 -7
  29. package/dist-types/commands/EvaluateMappingTemplateCommand.d.ts +20 -7
  30. package/dist-types/commands/FlushApiCacheCommand.d.ts +10 -5
  31. package/dist-types/commands/GetApiAssociationCommand.d.ts +15 -3
  32. package/dist-types/commands/GetApiCacheCommand.d.ts +19 -5
  33. package/dist-types/commands/GetDataSourceCommand.d.ts +63 -5
  34. package/dist-types/commands/GetDomainNameCommand.d.ts +16 -3
  35. package/dist-types/commands/GetFunctionCommand.d.ts +32 -3
  36. package/dist-types/commands/GetGraphqlApiCommand.d.ts +70 -3
  37. package/dist-types/commands/GetIntrospectionSchemaCommand.d.ts +8 -1
  38. package/dist-types/commands/GetResolverCommand.d.ts +42 -3
  39. package/dist-types/commands/GetSchemaCreationStatusCommand.d.ts +11 -3
  40. package/dist-types/commands/GetTypeCommand.d.ts +18 -5
  41. package/dist-types/commands/ListApiKeysCommand.d.ts +22 -6
  42. package/dist-types/commands/ListDataSourcesCommand.d.ts +64 -3
  43. package/dist-types/commands/ListDomainNamesCommand.d.ts +17 -2
  44. package/dist-types/commands/ListFunctionsCommand.d.ts +35 -3
  45. package/dist-types/commands/ListGraphqlApisCommand.d.ts +71 -2
  46. package/dist-types/commands/ListResolversByFunctionCommand.d.ts +45 -3
  47. package/dist-types/commands/ListResolversCommand.d.ts +45 -3
  48. package/dist-types/commands/ListTagsForResourceCommand.d.ts +12 -3
  49. package/dist-types/commands/ListTypesCommand.d.ts +21 -5
  50. package/dist-types/commands/StartSchemaCreationCommand.d.ts +14 -7
  51. package/dist-types/commands/TagResourceCommand.d.ts +8 -3
  52. package/dist-types/commands/UntagResourceCommand.d.ts +8 -3
  53. package/dist-types/commands/UpdateApiCacheCommand.d.ts +19 -5
  54. package/dist-types/commands/UpdateApiKeyCommand.d.ts +15 -3
  55. package/dist-types/commands/UpdateDataSourceCommand.d.ts +63 -5
  56. package/dist-types/commands/UpdateDomainNameCommand.d.ts +18 -5
  57. package/dist-types/commands/UpdateFunctionCommand.d.ts +32 -3
  58. package/dist-types/commands/UpdateGraphqlApiCommand.d.ts +72 -5
  59. package/dist-types/commands/UpdateResolverCommand.d.ts +44 -5
  60. package/dist-types/commands/UpdateTypeCommand.d.ts +18 -5
  61. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  62. package/dist-types/models/models_0.d.ts +383 -287
  63. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  64. package/dist-types/ts3.4/models/models_0.d.ts +9 -0
  65. package/package.json +3 -3
@@ -20,8 +20,8 @@ export interface CreateResolverCommandOutput extends CreateResolverResponse, __M
20
20
  /**
21
21
  * @public
22
22
  * <p>Creates a <code>Resolver</code> object.</p>
23
- * <p>A resolver converts incoming requests into a format that a data source can understand, and converts the data
24
- * source's responses into GraphQL.</p>
23
+ * <p>A resolver converts incoming requests into a format that a data source can understand,
24
+ * and converts the data source's responses into GraphQL.</p>
25
25
  * @example
26
26
  * Use a bare-bones client and the command you need to make an API call.
27
27
  * ```javascript
@@ -63,6 +63,42 @@ export interface CreateResolverCommandOutput extends CreateResolverResponse, __M
63
63
  * };
64
64
  * const command = new CreateResolverCommand(input);
65
65
  * const response = await client.send(command);
66
+ * // { // CreateResolverResponse
67
+ * // resolver: { // Resolver
68
+ * // typeName: "STRING_VALUE",
69
+ * // fieldName: "STRING_VALUE",
70
+ * // dataSourceName: "STRING_VALUE",
71
+ * // resolverArn: "STRING_VALUE",
72
+ * // requestMappingTemplate: "STRING_VALUE",
73
+ * // responseMappingTemplate: "STRING_VALUE",
74
+ * // kind: "UNIT" || "PIPELINE",
75
+ * // pipelineConfig: { // PipelineConfig
76
+ * // functions: [ // FunctionsIds
77
+ * // "STRING_VALUE",
78
+ * // ],
79
+ * // },
80
+ * // syncConfig: { // SyncConfig
81
+ * // conflictHandler: "OPTIMISTIC_CONCURRENCY" || "LAMBDA" || "AUTOMERGE" || "NONE",
82
+ * // conflictDetection: "VERSION" || "NONE",
83
+ * // lambdaConflictHandlerConfig: { // LambdaConflictHandlerConfig
84
+ * // lambdaConflictHandlerArn: "STRING_VALUE",
85
+ * // },
86
+ * // },
87
+ * // cachingConfig: { // CachingConfig
88
+ * // ttl: Number("long"), // required
89
+ * // cachingKeys: [ // CachingKeys
90
+ * // "STRING_VALUE",
91
+ * // ],
92
+ * // },
93
+ * // maxBatchSize: Number("int"),
94
+ * // runtime: { // AppSyncRuntime
95
+ * // name: "APPSYNC_JS", // required
96
+ * // runtimeVersion: "STRING_VALUE", // required
97
+ * // },
98
+ * // code: "STRING_VALUE",
99
+ * // },
100
+ * // };
101
+ *
66
102
  * ```
67
103
  *
68
104
  * @param CreateResolverCommandInput - {@link CreateResolverCommandInput}
@@ -72,22 +108,25 @@ export interface CreateResolverCommandOutput extends CreateResolverResponse, __M
72
108
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
73
109
  *
74
110
  * @throws {@link BadRequestException} (client fault)
75
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
76
- * field values, and then try again.</p>
111
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
112
+ * missing. Check the field values, and then try again.</p>
77
113
  *
78
114
  * @throws {@link ConcurrentModificationException} (client fault)
79
- * <p>Another modification is in progress at this time and it must complete before you can make your
80
- * change.</p>
115
+ * <p>Another modification is in progress at this time and it must complete before you can
116
+ * make your change.</p>
81
117
  *
82
118
  * @throws {@link InternalFailureException} (server fault)
83
119
  * <p>An internal AppSync error occurred. Try your request again.</p>
84
120
  *
85
121
  * @throws {@link NotFoundException} (client fault)
86
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
122
+ * <p>The resource specified in the request was not found. Check the resource, and then try
123
+ * again.</p>
87
124
  *
88
125
  * @throws {@link UnauthorizedException} (client fault)
89
126
  * <p>You aren't authorized to perform this operation.</p>
90
127
  *
128
+ * @throws {@link AppSyncServiceException}
129
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
91
130
  *
92
131
  */
93
132
  export declare class CreateResolverCommand extends $Command<CreateResolverCommandInput, CreateResolverCommandOutput, AppSyncClientResolvedConfig> {
@@ -33,6 +33,16 @@ export interface CreateTypeCommandOutput extends CreateTypeResponse, __MetadataB
33
33
  * };
34
34
  * const command = new CreateTypeCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // CreateTypeResponse
37
+ * // type: { // Type
38
+ * // name: "STRING_VALUE",
39
+ * // description: "STRING_VALUE",
40
+ * // arn: "STRING_VALUE",
41
+ * // definition: "STRING_VALUE",
42
+ * // format: "SDL" || "JSON",
43
+ * // },
44
+ * // };
45
+ *
36
46
  * ```
37
47
  *
38
48
  * @param CreateTypeCommandInput - {@link CreateTypeCommandInput}
@@ -42,22 +52,25 @@ export interface CreateTypeCommandOutput extends CreateTypeResponse, __MetadataB
42
52
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
43
53
  *
44
54
  * @throws {@link BadRequestException} (client fault)
45
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
46
- * field values, and then try again.</p>
55
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
56
+ * missing. Check the field values, and then try again.</p>
47
57
  *
48
58
  * @throws {@link ConcurrentModificationException} (client fault)
49
- * <p>Another modification is in progress at this time and it must complete before you can make your
50
- * change.</p>
59
+ * <p>Another modification is in progress at this time and it must complete before you can
60
+ * make your change.</p>
51
61
  *
52
62
  * @throws {@link InternalFailureException} (server fault)
53
63
  * <p>An internal AppSync error occurred. Try your request again.</p>
54
64
  *
55
65
  * @throws {@link NotFoundException} (client fault)
56
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
66
+ * <p>The resource specified in the request was not found. Check the resource, and then try
67
+ * again.</p>
57
68
  *
58
69
  * @throws {@link UnauthorizedException} (client fault)
59
70
  * <p>You aren't authorized to perform this operation.</p>
60
71
  *
72
+ * @throws {@link AppSyncServiceException}
73
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
61
74
  *
62
75
  */
63
76
  export declare class CreateTypeCommand extends $Command<CreateTypeCommandInput, CreateTypeCommandOutput, AppSyncClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteApiCacheCommandOutput extends DeleteApiCacheResponse, __M
31
31
  * };
32
32
  * const command = new DeleteApiCacheCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteApiCacheCommandInput - {@link DeleteApiCacheCommandInput}
@@ -40,22 +42,25 @@ export interface DeleteApiCacheCommandOutput extends DeleteApiCacheResponse, __M
40
42
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
41
43
  *
42
44
  * @throws {@link BadRequestException} (client fault)
43
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
44
- * field values, and then try again.</p>
45
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
46
+ * missing. Check the field values, and then try again.</p>
45
47
  *
46
48
  * @throws {@link ConcurrentModificationException} (client fault)
47
- * <p>Another modification is in progress at this time and it must complete before you can make your
48
- * change.</p>
49
+ * <p>Another modification is in progress at this time and it must complete before you can
50
+ * make your change.</p>
49
51
  *
50
52
  * @throws {@link InternalFailureException} (server fault)
51
53
  * <p>An internal AppSync error occurred. Try your request again.</p>
52
54
  *
53
55
  * @throws {@link NotFoundException} (client fault)
54
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
56
+ * <p>The resource specified in the request was not found. Check the resource, and then try
57
+ * again.</p>
55
58
  *
56
59
  * @throws {@link UnauthorizedException} (client fault)
57
60
  * <p>You aren't authorized to perform this operation.</p>
58
61
  *
62
+ * @throws {@link AppSyncServiceException}
63
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
59
64
  *
60
65
  */
61
66
  export declare class DeleteApiCacheCommand extends $Command<DeleteApiCacheCommandInput, DeleteApiCacheCommandOutput, AppSyncClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteApiKeyCommandOutput extends DeleteApiKeyResponse, __Metad
32
32
  * };
33
33
  * const command = new DeleteApiKeyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteApiKeyCommandInput - {@link DeleteApiKeyCommandInput}
@@ -41,18 +43,21 @@ export interface DeleteApiKeyCommandOutput extends DeleteApiKeyResponse, __Metad
41
43
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
42
44
  *
43
45
  * @throws {@link BadRequestException} (client fault)
44
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
45
- * field values, and then try again.</p>
46
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
47
+ * missing. Check the field values, and then try again.</p>
46
48
  *
47
49
  * @throws {@link InternalFailureException} (server fault)
48
50
  * <p>An internal AppSync error occurred. Try your request again.</p>
49
51
  *
50
52
  * @throws {@link NotFoundException} (client fault)
51
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
53
+ * <p>The resource specified in the request was not found. Check the resource, and then try
54
+ * again.</p>
52
55
  *
53
56
  * @throws {@link UnauthorizedException} (client fault)
54
57
  * <p>You aren't authorized to perform this operation.</p>
55
58
  *
59
+ * @throws {@link AppSyncServiceException}
60
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
56
61
  *
57
62
  */
58
63
  export declare class DeleteApiKeyCommand extends $Command<DeleteApiKeyCommandInput, DeleteApiKeyCommandOutput, AppSyncClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse,
32
32
  * };
33
33
  * const command = new DeleteDataSourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteDataSourceCommandInput - {@link DeleteDataSourceCommandInput}
@@ -41,22 +43,25 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse,
41
43
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
42
44
  *
43
45
  * @throws {@link BadRequestException} (client fault)
44
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
45
- * field values, and then try again.</p>
46
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
47
+ * missing. Check the field values, and then try again.</p>
46
48
  *
47
49
  * @throws {@link ConcurrentModificationException} (client fault)
48
- * <p>Another modification is in progress at this time and it must complete before you can make your
49
- * change.</p>
50
+ * <p>Another modification is in progress at this time and it must complete before you can
51
+ * make your change.</p>
50
52
  *
51
53
  * @throws {@link InternalFailureException} (server fault)
52
54
  * <p>An internal AppSync error occurred. Try your request again.</p>
53
55
  *
54
56
  * @throws {@link NotFoundException} (client fault)
55
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
57
+ * <p>The resource specified in the request was not found. Check the resource, and then try
58
+ * again.</p>
56
59
  *
57
60
  * @throws {@link UnauthorizedException} (client fault)
58
61
  * <p>You aren't authorized to perform this operation.</p>
59
62
  *
63
+ * @throws {@link AppSyncServiceException}
64
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
60
65
  *
61
66
  */
62
67
  export declare class DeleteDataSourceCommand extends $Command<DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput, AppSyncClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteDomainNameCommandOutput extends DeleteDomainNameResponse,
31
31
  * };
32
32
  * const command = new DeleteDomainNameCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteDomainNameCommandInput - {@link DeleteDomainNameCommandInput}
@@ -43,19 +45,22 @@ export interface DeleteDomainNameCommandOutput extends DeleteDomainNameResponse,
43
45
  * <p>You don't have access to perform this operation on this resource.</p>
44
46
  *
45
47
  * @throws {@link BadRequestException} (client fault)
46
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
47
- * field values, and then try again.</p>
48
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
49
+ * missing. Check the field values, and then try again.</p>
48
50
  *
49
51
  * @throws {@link ConcurrentModificationException} (client fault)
50
- * <p>Another modification is in progress at this time and it must complete before you can make your
51
- * change.</p>
52
+ * <p>Another modification is in progress at this time and it must complete before you can
53
+ * make your change.</p>
52
54
  *
53
55
  * @throws {@link InternalFailureException} (server fault)
54
56
  * <p>An internal AppSync error occurred. Try your request again.</p>
55
57
  *
56
58
  * @throws {@link NotFoundException} (client fault)
57
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
59
+ * <p>The resource specified in the request was not found. Check the resource, and then try
60
+ * again.</p>
58
61
  *
62
+ * @throws {@link AppSyncServiceException}
63
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
59
64
  *
60
65
  */
61
66
  export declare class DeleteDomainNameCommand extends $Command<DeleteDomainNameCommandInput, DeleteDomainNameCommandOutput, AppSyncClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteFunctionCommandOutput extends DeleteFunctionResponse, __M
32
32
  * };
33
33
  * const command = new DeleteFunctionCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteFunctionCommandInput - {@link DeleteFunctionCommandInput}
@@ -41,18 +43,21 @@ export interface DeleteFunctionCommandOutput extends DeleteFunctionResponse, __M
41
43
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
42
44
  *
43
45
  * @throws {@link ConcurrentModificationException} (client fault)
44
- * <p>Another modification is in progress at this time and it must complete before you can make your
45
- * change.</p>
46
+ * <p>Another modification is in progress at this time and it must complete before you can
47
+ * make your change.</p>
46
48
  *
47
49
  * @throws {@link InternalFailureException} (server fault)
48
50
  * <p>An internal AppSync error occurred. Try your request again.</p>
49
51
  *
50
52
  * @throws {@link NotFoundException} (client fault)
51
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
53
+ * <p>The resource specified in the request was not found. Check the resource, and then try
54
+ * again.</p>
52
55
  *
53
56
  * @throws {@link UnauthorizedException} (client fault)
54
57
  * <p>You aren't authorized to perform this operation.</p>
55
58
  *
59
+ * @throws {@link AppSyncServiceException}
60
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
56
61
  *
57
62
  */
58
63
  export declare class DeleteFunctionCommand extends $Command<DeleteFunctionCommandInput, DeleteFunctionCommandOutput, AppSyncClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteGraphqlApiCommandOutput extends DeleteGraphqlApiResponse,
31
31
  * };
32
32
  * const command = new DeleteGraphqlApiCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteGraphqlApiCommandInput - {@link DeleteGraphqlApiCommandInput}
@@ -43,22 +45,25 @@ export interface DeleteGraphqlApiCommandOutput extends DeleteGraphqlApiResponse,
43
45
  * <p>You don't have access to perform this operation on this resource.</p>
44
46
  *
45
47
  * @throws {@link BadRequestException} (client fault)
46
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
47
- * field values, and then try again.</p>
48
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
49
+ * missing. Check the field values, and then try again.</p>
48
50
  *
49
51
  * @throws {@link ConcurrentModificationException} (client fault)
50
- * <p>Another modification is in progress at this time and it must complete before you can make your
51
- * change.</p>
52
+ * <p>Another modification is in progress at this time and it must complete before you can
53
+ * make your change.</p>
52
54
  *
53
55
  * @throws {@link InternalFailureException} (server fault)
54
56
  * <p>An internal AppSync error occurred. Try your request again.</p>
55
57
  *
56
58
  * @throws {@link NotFoundException} (client fault)
57
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
59
+ * <p>The resource specified in the request was not found. Check the resource, and then try
60
+ * again.</p>
58
61
  *
59
62
  * @throws {@link UnauthorizedException} (client fault)
60
63
  * <p>You aren't authorized to perform this operation.</p>
61
64
  *
65
+ * @throws {@link AppSyncServiceException}
66
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
62
67
  *
63
68
  */
64
69
  export declare class DeleteGraphqlApiCommand extends $Command<DeleteGraphqlApiCommandInput, DeleteGraphqlApiCommandOutput, AppSyncClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteResolverCommandOutput extends DeleteResolverResponse, __M
33
33
  * };
34
34
  * const command = new DeleteResolverCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteResolverCommandInput - {@link DeleteResolverCommandInput}
@@ -42,22 +44,25 @@ export interface DeleteResolverCommandOutput extends DeleteResolverResponse, __M
42
44
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
43
45
  *
44
46
  * @throws {@link BadRequestException} (client fault)
45
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
46
- * field values, and then try again.</p>
47
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
48
+ * missing. Check the field values, and then try again.</p>
47
49
  *
48
50
  * @throws {@link ConcurrentModificationException} (client fault)
49
- * <p>Another modification is in progress at this time and it must complete before you can make your
50
- * change.</p>
51
+ * <p>Another modification is in progress at this time and it must complete before you can
52
+ * make your change.</p>
51
53
  *
52
54
  * @throws {@link InternalFailureException} (server fault)
53
55
  * <p>An internal AppSync error occurred. Try your request again.</p>
54
56
  *
55
57
  * @throws {@link NotFoundException} (client fault)
56
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
58
+ * <p>The resource specified in the request was not found. Check the resource, and then try
59
+ * again.</p>
57
60
  *
58
61
  * @throws {@link UnauthorizedException} (client fault)
59
62
  * <p>You aren't authorized to perform this operation.</p>
60
63
  *
64
+ * @throws {@link AppSyncServiceException}
65
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
61
66
  *
62
67
  */
63
68
  export declare class DeleteResolverCommand extends $Command<DeleteResolverCommandInput, DeleteResolverCommandOutput, AppSyncClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteTypeCommandOutput extends DeleteTypeResponse, __MetadataB
32
32
  * };
33
33
  * const command = new DeleteTypeCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteTypeCommandInput - {@link DeleteTypeCommandInput}
@@ -41,22 +43,25 @@ export interface DeleteTypeCommandOutput extends DeleteTypeResponse, __MetadataB
41
43
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
42
44
  *
43
45
  * @throws {@link BadRequestException} (client fault)
44
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
45
- * field values, and then try again.</p>
46
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
47
+ * missing. Check the field values, and then try again.</p>
46
48
  *
47
49
  * @throws {@link ConcurrentModificationException} (client fault)
48
- * <p>Another modification is in progress at this time and it must complete before you can make your
49
- * change.</p>
50
+ * <p>Another modification is in progress at this time and it must complete before you can
51
+ * make your change.</p>
50
52
  *
51
53
  * @throws {@link InternalFailureException} (server fault)
52
54
  * <p>An internal AppSync error occurred. Try your request again.</p>
53
55
  *
54
56
  * @throws {@link NotFoundException} (client fault)
55
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
57
+ * <p>The resource specified in the request was not found. Check the resource, and then try
58
+ * again.</p>
56
59
  *
57
60
  * @throws {@link UnauthorizedException} (client fault)
58
61
  * <p>You aren't authorized to perform this operation.</p>
59
62
  *
63
+ * @throws {@link AppSyncServiceException}
64
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
60
65
  *
61
66
  */
62
67
  export declare class DeleteTypeCommand extends $Command<DeleteTypeCommandInput, DeleteTypeCommandOutput, AppSyncClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DisassociateApiCommandOutput extends DisassociateApiResponse, _
31
31
  * };
32
32
  * const command = new DisassociateApiCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DisassociateApiCommandInput - {@link DisassociateApiCommandInput}
@@ -43,19 +45,22 @@ export interface DisassociateApiCommandOutput extends DisassociateApiResponse, _
43
45
  * <p>You don't have access to perform this operation on this resource.</p>
44
46
  *
45
47
  * @throws {@link BadRequestException} (client fault)
46
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
47
- * field values, and then try again.</p>
48
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
49
+ * missing. Check the field values, and then try again.</p>
48
50
  *
49
51
  * @throws {@link ConcurrentModificationException} (client fault)
50
- * <p>Another modification is in progress at this time and it must complete before you can make your
51
- * change.</p>
52
+ * <p>Another modification is in progress at this time and it must complete before you can
53
+ * make your change.</p>
52
54
  *
53
55
  * @throws {@link InternalFailureException} (server fault)
54
56
  * <p>An internal AppSync error occurred. Try your request again.</p>
55
57
  *
56
58
  * @throws {@link NotFoundException} (client fault)
57
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
59
+ * <p>The resource specified in the request was not found. Check the resource, and then try
60
+ * again.</p>
58
61
  *
62
+ * @throws {@link AppSyncServiceException}
63
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
59
64
  *
60
65
  */
61
66
  export declare class DisassociateApiCommand extends $Command<DisassociateApiCommandInput, DisassociateApiCommandOutput, AppSyncClientResolvedConfig> {
@@ -19,11 +19,12 @@ export interface EvaluateCodeCommandOutput extends EvaluateCodeResponse, __Metad
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Evaluates the given code and returns the response. The code definition requirements depend on the specified
23
- * runtime. For <code>APPSYNC_JS</code> runtimes, the code defines the request and response functions. The request
24
- * function takes the incoming request after a GraphQL operation is parsed and converts it into a request
25
- * configuration for the selected data source operation. The response function interprets responses from the data
26
- * source and maps it to the shape of the GraphQL field output type. </p>
22
+ * <p>Evaluates the given code and returns the response. The code definition requirements
23
+ * depend on the specified runtime. For <code>APPSYNC_JS</code> runtimes, the code defines the
24
+ * request and response functions. The request function takes the incoming request after a
25
+ * GraphQL operation is parsed and converts it into a request configuration for the selected
26
+ * data source operation. The response function interprets responses from the data source and
27
+ * maps it to the shape of the GraphQL field output type. </p>
27
28
  * @example
28
29
  * Use a bare-bones client and the command you need to make an API call.
29
30
  * ```javascript
@@ -41,6 +42,27 @@ export interface EvaluateCodeCommandOutput extends EvaluateCodeResponse, __Metad
41
42
  * };
42
43
  * const command = new EvaluateCodeCommand(input);
43
44
  * const response = await client.send(command);
45
+ * // { // EvaluateCodeResponse
46
+ * // evaluationResult: "STRING_VALUE",
47
+ * // error: { // EvaluateCodeErrorDetail
48
+ * // message: "STRING_VALUE",
49
+ * // codeErrors: [ // CodeErrors
50
+ * // { // CodeError
51
+ * // errorType: "STRING_VALUE",
52
+ * // value: "STRING_VALUE",
53
+ * // location: { // CodeErrorLocation
54
+ * // line: Number("int"),
55
+ * // column: Number("int"),
56
+ * // span: Number("int"),
57
+ * // },
58
+ * // },
59
+ * // ],
60
+ * // },
61
+ * // logs: [ // Logs
62
+ * // "STRING_VALUE",
63
+ * // ],
64
+ * // };
65
+ *
44
66
  * ```
45
67
  *
46
68
  * @param EvaluateCodeCommandInput - {@link EvaluateCodeCommandInput}
@@ -53,12 +75,14 @@ export interface EvaluateCodeCommandOutput extends EvaluateCodeResponse, __Metad
53
75
  * <p>You don't have access to perform this operation on this resource.</p>
54
76
  *
55
77
  * @throws {@link BadRequestException} (client fault)
56
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
57
- * field values, and then try again.</p>
78
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
79
+ * missing. Check the field values, and then try again.</p>
58
80
  *
59
81
  * @throws {@link InternalFailureException} (server fault)
60
82
  * <p>An internal AppSync error occurred. Try your request again.</p>
61
83
  *
84
+ * @throws {@link AppSyncServiceException}
85
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
62
86
  *
63
87
  */
64
88
  export declare class EvaluateCodeCommand extends $Command<EvaluateCodeCommandInput, EvaluateCodeCommandOutput, AppSyncClientResolvedConfig> {
@@ -19,11 +19,12 @@ export interface EvaluateMappingTemplateCommandOutput extends EvaluateMappingTem
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Evaluates a given template and returns the response. The mapping template can be a request or response
23
- * template.</p>
24
- * <p>Request templates take the incoming request after a GraphQL operation is parsed and convert it into a
25
- * request configuration for the selected data source operation. Response templates interpret responses from the
26
- * data source and map it to the shape of the GraphQL field output type.</p>
22
+ * <p>Evaluates a given template and returns the response. The mapping template can be a
23
+ * request or response template.</p>
24
+ * <p>Request templates take the incoming request after a GraphQL operation is parsed and
25
+ * convert it into a request configuration for the selected data source operation. Response
26
+ * templates interpret responses from the data source and map it to the shape of the GraphQL
27
+ * field output type.</p>
27
28
  * <p>Mapping templates are written in the Apache Velocity Template Language (VTL).</p>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -37,6 +38,16 @@ export interface EvaluateMappingTemplateCommandOutput extends EvaluateMappingTem
37
38
  * };
38
39
  * const command = new EvaluateMappingTemplateCommand(input);
39
40
  * const response = await client.send(command);
41
+ * // { // EvaluateMappingTemplateResponse
42
+ * // evaluationResult: "STRING_VALUE",
43
+ * // error: { // ErrorDetail
44
+ * // message: "STRING_VALUE",
45
+ * // },
46
+ * // logs: [ // Logs
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // };
50
+ *
40
51
  * ```
41
52
  *
42
53
  * @param EvaluateMappingTemplateCommandInput - {@link EvaluateMappingTemplateCommandInput}
@@ -49,12 +60,14 @@ export interface EvaluateMappingTemplateCommandOutput extends EvaluateMappingTem
49
60
  * <p>You don't have access to perform this operation on this resource.</p>
50
61
  *
51
62
  * @throws {@link BadRequestException} (client fault)
52
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
53
- * field values, and then try again.</p>
63
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
64
+ * missing. Check the field values, and then try again.</p>
54
65
  *
55
66
  * @throws {@link InternalFailureException} (server fault)
56
67
  * <p>An internal AppSync error occurred. Try your request again.</p>
57
68
  *
69
+ * @throws {@link AppSyncServiceException}
70
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
58
71
  *
59
72
  */
60
73
  export declare class EvaluateMappingTemplateCommand extends $Command<EvaluateMappingTemplateCommandInput, EvaluateMappingTemplateCommandOutput, AppSyncClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface FlushApiCacheCommandOutput extends FlushApiCacheResponse, __Met
31
31
  * };
32
32
  * const command = new FlushApiCacheCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param FlushApiCacheCommandInput - {@link FlushApiCacheCommandInput}
@@ -40,22 +42,25 @@ export interface FlushApiCacheCommandOutput extends FlushApiCacheResponse, __Met
40
42
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
41
43
  *
42
44
  * @throws {@link BadRequestException} (client fault)
43
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
44
- * field values, and then try again.</p>
45
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
46
+ * missing. Check the field values, and then try again.</p>
45
47
  *
46
48
  * @throws {@link ConcurrentModificationException} (client fault)
47
- * <p>Another modification is in progress at this time and it must complete before you can make your
48
- * change.</p>
49
+ * <p>Another modification is in progress at this time and it must complete before you can
50
+ * make your change.</p>
49
51
  *
50
52
  * @throws {@link InternalFailureException} (server fault)
51
53
  * <p>An internal AppSync error occurred. Try your request again.</p>
52
54
  *
53
55
  * @throws {@link NotFoundException} (client fault)
54
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
56
+ * <p>The resource specified in the request was not found. Check the resource, and then try
57
+ * again.</p>
55
58
  *
56
59
  * @throws {@link UnauthorizedException} (client fault)
57
60
  * <p>You aren't authorized to perform this operation.</p>
58
61
  *
62
+ * @throws {@link AppSyncServiceException}
63
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
59
64
  *
60
65
  */
61
66
  export declare class FlushApiCacheCommand extends $Command<FlushApiCacheCommandInput, FlushApiCacheCommandOutput, AppSyncClientResolvedConfig> {