@aws-sdk/client-appsync 3.682.0 → 3.683.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 (121) hide show
  1. package/README.md +90 -10
  2. package/dist-cjs/index.js +572 -0
  3. package/dist-es/AppSync.js +20 -0
  4. package/dist-es/commands/CreateApiCommand.js +22 -0
  5. package/dist-es/commands/CreateChannelNamespaceCommand.js +22 -0
  6. package/dist-es/commands/DeleteApiCommand.js +22 -0
  7. package/dist-es/commands/DeleteChannelNamespaceCommand.js +22 -0
  8. package/dist-es/commands/GetApiCommand.js +22 -0
  9. package/dist-es/commands/GetChannelNamespaceCommand.js +22 -0
  10. package/dist-es/commands/ListApisCommand.js +22 -0
  11. package/dist-es/commands/ListChannelNamespacesCommand.js +22 -0
  12. package/dist-es/commands/UpdateApiCommand.js +22 -0
  13. package/dist-es/commands/UpdateChannelNamespaceCommand.js +22 -0
  14. package/dist-es/commands/index.js +10 -0
  15. package/dist-es/models/models_0.js +31 -0
  16. package/dist-es/pagination/ListApisPaginator.js +4 -0
  17. package/dist-es/pagination/ListChannelNamespacesPaginator.js +4 -0
  18. package/dist-es/pagination/index.js +2 -0
  19. package/dist-es/protocols/Aws_restJson1.js +341 -2
  20. package/dist-types/AppSync.d.ts +73 -2
  21. package/dist-types/AppSyncClient.d.ts +14 -4
  22. package/dist-types/commands/AssociateApiCommand.d.ts +4 -3
  23. package/dist-types/commands/AssociateMergedGraphqlApiCommand.d.ts +8 -6
  24. package/dist-types/commands/AssociateSourceGraphqlApiCommand.d.ts +8 -6
  25. package/dist-types/commands/CreateApiCacheCommand.d.ts +6 -5
  26. package/dist-types/commands/CreateApiCommand.d.ts +192 -0
  27. package/dist-types/commands/CreateApiKeyCommand.d.ts +4 -3
  28. package/dist-types/commands/CreateChannelNamespaceCommand.d.ts +133 -0
  29. package/dist-types/commands/CreateDataSourceCommand.d.ts +6 -5
  30. package/dist-types/commands/CreateDomainNameCommand.d.ts +2 -2
  31. package/dist-types/commands/CreateFunctionCommand.d.ts +8 -6
  32. package/dist-types/commands/CreateGraphqlApiCommand.d.ts +5 -5
  33. package/dist-types/commands/CreateResolverCommand.d.ts +8 -7
  34. package/dist-types/commands/CreateTypeCommand.d.ts +6 -5
  35. package/dist-types/commands/DeleteApiCacheCommand.d.ts +6 -5
  36. package/dist-types/commands/DeleteApiCommand.d.ts +90 -0
  37. package/dist-types/commands/DeleteApiKeyCommand.d.ts +4 -3
  38. package/dist-types/commands/DeleteChannelNamespaceCommand.d.ts +91 -0
  39. package/dist-types/commands/DeleteDataSourceCommand.d.ts +6 -5
  40. package/dist-types/commands/DeleteDomainNameCommand.d.ts +6 -5
  41. package/dist-types/commands/DeleteFunctionCommand.d.ts +6 -5
  42. package/dist-types/commands/DeleteGraphqlApiCommand.d.ts +6 -5
  43. package/dist-types/commands/DeleteResolverCommand.d.ts +6 -5
  44. package/dist-types/commands/DeleteTypeCommand.d.ts +6 -5
  45. package/dist-types/commands/DisassociateApiCommand.d.ts +6 -5
  46. package/dist-types/commands/DisassociateMergedGraphqlApiCommand.d.ts +8 -7
  47. package/dist-types/commands/DisassociateSourceGraphqlApiCommand.d.ts +8 -7
  48. package/dist-types/commands/EvaluateCodeCommand.d.ts +8 -7
  49. package/dist-types/commands/EvaluateMappingTemplateCommand.d.ts +8 -7
  50. package/dist-types/commands/FlushApiCacheCommand.d.ts +6 -5
  51. package/dist-types/commands/GetApiAssociationCommand.d.ts +4 -3
  52. package/dist-types/commands/GetApiCacheCommand.d.ts +6 -5
  53. package/dist-types/commands/GetApiCommand.d.ts +144 -0
  54. package/dist-types/commands/GetChannelNamespaceCommand.d.ts +109 -0
  55. package/dist-types/commands/GetDataSourceCommand.d.ts +6 -5
  56. package/dist-types/commands/GetDataSourceIntrospectionCommand.d.ts +7 -6
  57. package/dist-types/commands/GetDomainNameCommand.d.ts +4 -3
  58. package/dist-types/commands/GetFunctionCommand.d.ts +4 -3
  59. package/dist-types/commands/GetGraphqlApiCommand.d.ts +4 -3
  60. package/dist-types/commands/GetGraphqlApiEnvironmentVariablesCommand.d.ts +6 -4
  61. package/dist-types/commands/GetIntrospectionSchemaCommand.d.ts +2 -1
  62. package/dist-types/commands/GetResolverCommand.d.ts +4 -3
  63. package/dist-types/commands/GetSchemaCreationStatusCommand.d.ts +4 -3
  64. package/dist-types/commands/GetSourceApiAssociationCommand.d.ts +4 -3
  65. package/dist-types/commands/GetTypeCommand.d.ts +6 -5
  66. package/dist-types/commands/ListApiKeysCommand.d.ts +8 -6
  67. package/dist-types/commands/ListApisCommand.d.ts +144 -0
  68. package/dist-types/commands/ListChannelNamespacesCommand.d.ts +114 -0
  69. package/dist-types/commands/ListDataSourcesCommand.d.ts +4 -3
  70. package/dist-types/commands/ListDomainNamesCommand.d.ts +2 -2
  71. package/dist-types/commands/ListFunctionsCommand.d.ts +4 -3
  72. package/dist-types/commands/ListGraphqlApisCommand.d.ts +2 -2
  73. package/dist-types/commands/ListResolversByFunctionCommand.d.ts +4 -3
  74. package/dist-types/commands/ListResolversCommand.d.ts +4 -3
  75. package/dist-types/commands/ListSourceApiAssociationsCommand.d.ts +4 -3
  76. package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -3
  77. package/dist-types/commands/ListTypesByAssociationCommand.d.ts +6 -5
  78. package/dist-types/commands/ListTypesCommand.d.ts +6 -5
  79. package/dist-types/commands/PutGraphqlApiEnvironmentVariablesCommand.d.ts +21 -17
  80. package/dist-types/commands/StartDataSourceIntrospectionCommand.d.ts +6 -5
  81. package/dist-types/commands/StartSchemaCreationCommand.d.ts +8 -7
  82. package/dist-types/commands/StartSchemaMergeCommand.d.ts +8 -6
  83. package/dist-types/commands/TagResourceCommand.d.ts +4 -3
  84. package/dist-types/commands/UntagResourceCommand.d.ts +4 -3
  85. package/dist-types/commands/UpdateApiCacheCommand.d.ts +6 -5
  86. package/dist-types/commands/UpdateApiCommand.d.ts +192 -0
  87. package/dist-types/commands/UpdateApiKeyCommand.d.ts +4 -3
  88. package/dist-types/commands/UpdateChannelNamespaceCommand.d.ts +124 -0
  89. package/dist-types/commands/UpdateDataSourceCommand.d.ts +6 -5
  90. package/dist-types/commands/UpdateDomainNameCommand.d.ts +6 -5
  91. package/dist-types/commands/UpdateFunctionCommand.d.ts +6 -5
  92. package/dist-types/commands/UpdateGraphqlApiCommand.d.ts +7 -6
  93. package/dist-types/commands/UpdateResolverCommand.d.ts +6 -5
  94. package/dist-types/commands/UpdateSourceApiAssociationCommand.d.ts +6 -5
  95. package/dist-types/commands/UpdateTypeCommand.d.ts +6 -5
  96. package/dist-types/commands/index.d.ts +10 -0
  97. package/dist-types/index.d.ts +2 -2
  98. package/dist-types/models/models_0.d.ts +1305 -629
  99. package/dist-types/pagination/ListApisPaginator.d.ts +7 -0
  100. package/dist-types/pagination/ListChannelNamespacesPaginator.d.ts +7 -0
  101. package/dist-types/pagination/index.d.ts +2 -0
  102. package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
  103. package/dist-types/ts3.4/AppSync.d.ts +171 -0
  104. package/dist-types/ts3.4/AppSyncClient.d.ts +60 -0
  105. package/dist-types/ts3.4/commands/CreateApiCommand.d.ts +47 -0
  106. package/dist-types/ts3.4/commands/CreateChannelNamespaceCommand.d.ts +51 -0
  107. package/dist-types/ts3.4/commands/DeleteApiCommand.d.ts +47 -0
  108. package/dist-types/ts3.4/commands/DeleteChannelNamespaceCommand.d.ts +51 -0
  109. package/dist-types/ts3.4/commands/GetApiCommand.d.ts +41 -0
  110. package/dist-types/ts3.4/commands/GetChannelNamespaceCommand.d.ts +51 -0
  111. package/dist-types/ts3.4/commands/ListApisCommand.d.ts +47 -0
  112. package/dist-types/ts3.4/commands/ListChannelNamespacesCommand.d.ts +51 -0
  113. package/dist-types/ts3.4/commands/UpdateApiCommand.d.ts +47 -0
  114. package/dist-types/ts3.4/commands/UpdateChannelNamespaceCommand.d.ts +51 -0
  115. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  116. package/dist-types/ts3.4/models/models_0.d.ts +148 -2
  117. package/dist-types/ts3.4/pagination/ListApisPaginator.d.ts +11 -0
  118. package/dist-types/ts3.4/pagination/ListChannelNamespacesPaginator.d.ts +11 -0
  119. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  120. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +120 -0
  121. package/package.json +1 -1
@@ -52,18 +52,19 @@ declare const DeleteResolverCommand_base: {
52
52
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
53
53
  *
54
54
  * @throws {@link BadRequestException} (client fault)
55
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
56
- * 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>
57
57
  *
58
58
  * @throws {@link ConcurrentModificationException} (client fault)
59
- * <p>Another modification is in progress at this time and it must complete before you can make your
60
- * change.</p>
59
+ * <p>Another modification is in progress at this time and it must complete before you can
60
+ * make your change.</p>
61
61
  *
62
62
  * @throws {@link InternalFailureException} (server fault)
63
63
  * <p>An internal AppSync error occurred. Try your request again.</p>
64
64
  *
65
65
  * @throws {@link NotFoundException} (client fault)
66
- * <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>
67
68
  *
68
69
  * @throws {@link UnauthorizedException} (client fault)
69
70
  * <p>You aren't authorized to perform this operation.</p>
@@ -51,18 +51,19 @@ declare const DeleteTypeCommand_base: {
51
51
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
52
52
  *
53
53
  * @throws {@link BadRequestException} (client fault)
54
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
55
- * field values, and then try again.</p>
54
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
55
+ * missing. Check the field values, and then try again.</p>
56
56
  *
57
57
  * @throws {@link ConcurrentModificationException} (client fault)
58
- * <p>Another modification is in progress at this time and it must complete before you can make your
59
- * change.</p>
58
+ * <p>Another modification is in progress at this time and it must complete before you can
59
+ * make your change.</p>
60
60
  *
61
61
  * @throws {@link InternalFailureException} (server fault)
62
62
  * <p>An internal AppSync error occurred. Try your request again.</p>
63
63
  *
64
64
  * @throws {@link NotFoundException} (client fault)
65
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
65
+ * <p>The resource specified in the request was not found. Check the resource, and then try
66
+ * again.</p>
66
67
  *
67
68
  * @throws {@link UnauthorizedException} (client fault)
68
69
  * <p>You aren't authorized to perform this operation.</p>
@@ -53,18 +53,19 @@ declare const DisassociateApiCommand_base: {
53
53
  * <p>You don't have access to perform this operation on this resource.</p>
54
54
  *
55
55
  * @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>
56
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
57
+ * missing. Check the field values, and then try again.</p>
58
58
  *
59
59
  * @throws {@link ConcurrentModificationException} (client fault)
60
- * <p>Another modification is in progress at this time and it must complete before you can make your
61
- * change.</p>
60
+ * <p>Another modification is in progress at this time and it must complete before you can
61
+ * make your change.</p>
62
62
  *
63
63
  * @throws {@link InternalFailureException} (server fault)
64
64
  * <p>An internal AppSync error occurred. Try your request again.</p>
65
65
  *
66
66
  * @throws {@link NotFoundException} (client fault)
67
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
67
+ * <p>The resource specified in the request was not found. Check the resource, and then try
68
+ * again.</p>
68
69
  *
69
70
  * @throws {@link AppSyncServiceException}
70
71
  * <p>Base exception class for all service exceptions from AppSync service.</p>
@@ -27,8 +27,8 @@ declare const DisassociateMergedGraphqlApiCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes an association between a Merged API and source API using the source API's identifier and the
31
- * association ID.</p>
30
+ * <p>Deletes an association between a Merged API and source API using the source API's
31
+ * identifier and the association ID.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -54,18 +54,19 @@ declare const DisassociateMergedGraphqlApiCommand_base: {
54
54
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
55
55
  *
56
56
  * @throws {@link BadRequestException} (client fault)
57
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
58
- * field values, and then try again.</p>
57
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
58
+ * missing. Check the field values, and then try again.</p>
59
59
  *
60
60
  * @throws {@link ConcurrentModificationException} (client fault)
61
- * <p>Another modification is in progress at this time and it must complete before you can make your
62
- * change.</p>
61
+ * <p>Another modification is in progress at this time and it must complete before you can
62
+ * make your change.</p>
63
63
  *
64
64
  * @throws {@link InternalFailureException} (server fault)
65
65
  * <p>An internal AppSync error occurred. Try your request again.</p>
66
66
  *
67
67
  * @throws {@link NotFoundException} (client fault)
68
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
68
+ * <p>The resource specified in the request was not found. Check the resource, and then try
69
+ * again.</p>
69
70
  *
70
71
  * @throws {@link UnauthorizedException} (client fault)
71
72
  * <p>You aren't authorized to perform this operation.</p>
@@ -27,8 +27,8 @@ declare const DisassociateSourceGraphqlApiCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes an association between a Merged API and source API using the Merged API's identifier and the
31
- * association ID.</p>
30
+ * <p>Deletes an association between a Merged API and source API using the Merged API's
31
+ * identifier and the association ID.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -54,18 +54,19 @@ declare const DisassociateSourceGraphqlApiCommand_base: {
54
54
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
55
55
  *
56
56
  * @throws {@link BadRequestException} (client fault)
57
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
58
- * field values, and then try again.</p>
57
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
58
+ * missing. Check the field values, and then try again.</p>
59
59
  *
60
60
  * @throws {@link ConcurrentModificationException} (client fault)
61
- * <p>Another modification is in progress at this time and it must complete before you can make your
62
- * change.</p>
61
+ * <p>Another modification is in progress at this time and it must complete before you can
62
+ * make your change.</p>
63
63
  *
64
64
  * @throws {@link InternalFailureException} (server fault)
65
65
  * <p>An internal AppSync error occurred. Try your request again.</p>
66
66
  *
67
67
  * @throws {@link NotFoundException} (client fault)
68
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
68
+ * <p>The resource specified in the request was not found. Check the resource, and then try
69
+ * again.</p>
69
70
  *
70
71
  * @throws {@link UnauthorizedException} (client fault)
71
72
  * <p>You aren't authorized to perform this operation.</p>
@@ -27,11 +27,12 @@ declare const EvaluateCodeCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Evaluates the given code and returns the response. The code definition requirements depend on the specified
31
- * runtime. For <code>APPSYNC_JS</code> runtimes, the code defines the request and response functions. The request
32
- * function takes the incoming request after a GraphQL operation is parsed and converts it into a request
33
- * configuration for the selected data source operation. The response function interprets responses from the data
34
- * source and maps it to the shape of the GraphQL field output type. </p>
30
+ * <p>Evaluates the given code and returns the response. The code definition requirements
31
+ * depend on the specified runtime. For <code>APPSYNC_JS</code> runtimes, the code defines the
32
+ * request and response functions. The request function takes the incoming request after a
33
+ * GraphQL operation is parsed and converts it into a request configuration for the selected
34
+ * data source operation. The response function interprets responses from the data source and
35
+ * maps it to the shape of the GraphQL field output type. </p>
35
36
  * @example
36
37
  * Use a bare-bones client and the command you need to make an API call.
37
38
  * ```javascript
@@ -82,8 +83,8 @@ declare const EvaluateCodeCommand_base: {
82
83
  * <p>You don't have access to perform this operation on this resource.</p>
83
84
  *
84
85
  * @throws {@link BadRequestException} (client fault)
85
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
86
- * field values, and then try again.</p>
86
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
87
+ * missing. Check the field values, and then try again.</p>
87
88
  *
88
89
  * @throws {@link InternalFailureException} (server fault)
89
90
  * <p>An internal AppSync error occurred. Try your request again.</p>
@@ -27,11 +27,12 @@ declare const EvaluateMappingTemplateCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Evaluates a given template and returns the response. The mapping template can be a request or response
31
- * template.</p>
32
- * <p>Request templates take the incoming request after a GraphQL operation is parsed and convert it into a
33
- * request configuration for the selected data source operation. Response templates interpret responses from the
34
- * data source and map it to the shape of the GraphQL field output type.</p>
30
+ * <p>Evaluates a given template and returns the response. The mapping template can be a
31
+ * request or response template.</p>
32
+ * <p>Request templates take the incoming request after a GraphQL operation is parsed and
33
+ * convert it into a request configuration for the selected data source operation. Response
34
+ * templates interpret responses from the data source and map it to the shape of the GraphQL
35
+ * field output type.</p>
35
36
  * <p>Mapping templates are written in the Apache Velocity Template Language (VTL).</p>
36
37
  * @example
37
38
  * Use a bare-bones client and the command you need to make an API call.
@@ -67,8 +68,8 @@ declare const EvaluateMappingTemplateCommand_base: {
67
68
  * <p>You don't have access to perform this operation on this resource.</p>
68
69
  *
69
70
  * @throws {@link BadRequestException} (client fault)
70
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
71
- * field values, and then try again.</p>
71
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
72
+ * missing. Check the field values, and then try again.</p>
72
73
  *
73
74
  * @throws {@link InternalFailureException} (server fault)
74
75
  * <p>An internal AppSync error occurred. Try your request again.</p>
@@ -50,18 +50,19 @@ declare const FlushApiCacheCommand_base: {
50
50
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
51
51
  *
52
52
  * @throws {@link BadRequestException} (client fault)
53
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
54
- * field values, and then try again.</p>
53
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
54
+ * missing. Check the field values, and then try again.</p>
55
55
  *
56
56
  * @throws {@link ConcurrentModificationException} (client fault)
57
- * <p>Another modification is in progress at this time and it must complete before you can make your
58
- * change.</p>
57
+ * <p>Another modification is in progress at this time and it must complete before you can
58
+ * make your change.</p>
59
59
  *
60
60
  * @throws {@link InternalFailureException} (server fault)
61
61
  * <p>An internal AppSync error occurred. Try your request again.</p>
62
62
  *
63
63
  * @throws {@link NotFoundException} (client fault)
64
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
64
+ * <p>The resource specified in the request was not found. Check the resource, and then try
65
+ * again.</p>
65
66
  *
66
67
  * @throws {@link UnauthorizedException} (client fault)
67
68
  * <p>You aren't authorized to perform this operation.</p>
@@ -60,14 +60,15 @@ declare const GetApiAssociationCommand_base: {
60
60
  * <p>You don't have access to perform this operation on this resource.</p>
61
61
  *
62
62
  * @throws {@link BadRequestException} (client fault)
63
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
64
- * 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>
65
65
  *
66
66
  * @throws {@link InternalFailureException} (server fault)
67
67
  * <p>An internal AppSync error occurred. Try your request again.</p>
68
68
  *
69
69
  * @throws {@link NotFoundException} (client fault)
70
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
70
+ * <p>The resource specified in the request was not found. Check the resource, and then try
71
+ * again.</p>
71
72
  *
72
73
  * @throws {@link AppSyncServiceException}
73
74
  * <p>Base exception class for all service exceptions from AppSync service.</p>
@@ -60,18 +60,19 @@ declare const GetApiCacheCommand_base: {
60
60
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
61
61
  *
62
62
  * @throws {@link BadRequestException} (client fault)
63
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
64
- * 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>
65
65
  *
66
66
  * @throws {@link ConcurrentModificationException} (client fault)
67
- * <p>Another modification is in progress at this time and it must complete before you can make your
68
- * change.</p>
67
+ * <p>Another modification is in progress at this time and it must complete before you can
68
+ * make your change.</p>
69
69
  *
70
70
  * @throws {@link InternalFailureException} (server fault)
71
71
  * <p>An internal AppSync error occurred. Try your request again.</p>
72
72
  *
73
73
  * @throws {@link NotFoundException} (client fault)
74
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
74
+ * <p>The resource specified in the request was not found. Check the resource, and then try
75
+ * again.</p>
75
76
  *
76
77
  * @throws {@link UnauthorizedException} (client fault)
77
78
  * <p>You aren't authorized to perform this operation.</p>
@@ -0,0 +1,144 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient";
4
+ import { GetApiRequest, GetApiResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetApiCommand}.
14
+ */
15
+ export interface GetApiCommandInput extends GetApiRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetApiCommand}.
21
+ */
22
+ export interface GetApiCommandOutput extends GetApiResponse, __MetadataBearer {
23
+ }
24
+ declare const GetApiCommand_base: {
25
+ new (input: GetApiCommandInput): import("@smithy/smithy-client").CommandImpl<GetApiCommandInput, GetApiCommandOutput, AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetApiCommandInput): import("@smithy/smithy-client").CommandImpl<GetApiCommandInput, GetApiCommandOutput, AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves an <code>Api</code> object.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { AppSyncClient, GetApiCommand } from "@aws-sdk/client-appsync"; // ES Modules import
35
+ * // const { AppSyncClient, GetApiCommand } = require("@aws-sdk/client-appsync"); // CommonJS import
36
+ * const client = new AppSyncClient(config);
37
+ * const input = { // GetApiRequest
38
+ * apiId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetApiCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetApiResponse
43
+ * // api: { // Api
44
+ * // apiId: "STRING_VALUE",
45
+ * // name: "STRING_VALUE",
46
+ * // ownerContact: "STRING_VALUE",
47
+ * // tags: { // TagMap
48
+ * // "<keys>": "STRING_VALUE",
49
+ * // },
50
+ * // dns: { // MapOfStringToString
51
+ * // "<keys>": "STRING_VALUE",
52
+ * // },
53
+ * // apiArn: "STRING_VALUE",
54
+ * // created: new Date("TIMESTAMP"),
55
+ * // xrayEnabled: true || false,
56
+ * // wafWebAclArn: "STRING_VALUE",
57
+ * // eventConfig: { // EventConfig
58
+ * // authProviders: [ // AuthProviders // required
59
+ * // { // AuthProvider
60
+ * // authType: "API_KEY" || "AWS_IAM" || "AMAZON_COGNITO_USER_POOLS" || "OPENID_CONNECT" || "AWS_LAMBDA", // required
61
+ * // cognitoConfig: { // CognitoConfig
62
+ * // userPoolId: "STRING_VALUE", // required
63
+ * // awsRegion: "STRING_VALUE", // required
64
+ * // appIdClientRegex: "STRING_VALUE",
65
+ * // },
66
+ * // openIDConnectConfig: { // OpenIDConnectConfig
67
+ * // issuer: "STRING_VALUE", // required
68
+ * // clientId: "STRING_VALUE",
69
+ * // iatTTL: Number("long"),
70
+ * // authTTL: Number("long"),
71
+ * // },
72
+ * // lambdaAuthorizerConfig: { // LambdaAuthorizerConfig
73
+ * // authorizerResultTtlInSeconds: Number("int"),
74
+ * // authorizerUri: "STRING_VALUE", // required
75
+ * // identityValidationExpression: "STRING_VALUE",
76
+ * // },
77
+ * // },
78
+ * // ],
79
+ * // connectionAuthModes: [ // AuthModes // required
80
+ * // { // AuthMode
81
+ * // authType: "API_KEY" || "AWS_IAM" || "AMAZON_COGNITO_USER_POOLS" || "OPENID_CONNECT" || "AWS_LAMBDA", // required
82
+ * // },
83
+ * // ],
84
+ * // defaultPublishAuthModes: [ // required
85
+ * // {
86
+ * // authType: "API_KEY" || "AWS_IAM" || "AMAZON_COGNITO_USER_POOLS" || "OPENID_CONNECT" || "AWS_LAMBDA", // required
87
+ * // },
88
+ * // ],
89
+ * // defaultSubscribeAuthModes: [ // required
90
+ * // {
91
+ * // authType: "API_KEY" || "AWS_IAM" || "AMAZON_COGNITO_USER_POOLS" || "OPENID_CONNECT" || "AWS_LAMBDA", // required
92
+ * // },
93
+ * // ],
94
+ * // logConfig: { // EventLogConfig
95
+ * // logLevel: "NONE" || "ERROR" || "ALL" || "INFO" || "DEBUG", // required
96
+ * // cloudWatchLogsRoleArn: "STRING_VALUE", // required
97
+ * // },
98
+ * // },
99
+ * // },
100
+ * // };
101
+ *
102
+ * ```
103
+ *
104
+ * @param GetApiCommandInput - {@link GetApiCommandInput}
105
+ * @returns {@link GetApiCommandOutput}
106
+ * @see {@link GetApiCommandInput} for command's `input` shape.
107
+ * @see {@link GetApiCommandOutput} for command's `response` shape.
108
+ * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
109
+ *
110
+ * @throws {@link AccessDeniedException} (client fault)
111
+ * <p>You don't have access to perform this operation on this resource.</p>
112
+ *
113
+ * @throws {@link BadRequestException} (client fault)
114
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
115
+ * missing. Check the field values, and then try again.</p>
116
+ *
117
+ * @throws {@link InternalFailureException} (server fault)
118
+ * <p>An internal AppSync error occurred. Try your request again.</p>
119
+ *
120
+ * @throws {@link NotFoundException} (client fault)
121
+ * <p>The resource specified in the request was not found. Check the resource, and then try
122
+ * again.</p>
123
+ *
124
+ * @throws {@link UnauthorizedException} (client fault)
125
+ * <p>You aren't authorized to perform this operation.</p>
126
+ *
127
+ * @throws {@link AppSyncServiceException}
128
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
129
+ *
130
+ * @public
131
+ */
132
+ export declare class GetApiCommand extends GetApiCommand_base {
133
+ /** @internal type navigation helper, not in runtime. */
134
+ protected static __types: {
135
+ api: {
136
+ input: GetApiRequest;
137
+ output: GetApiResponse;
138
+ };
139
+ sdk: {
140
+ input: GetApiCommandInput;
141
+ output: GetApiCommandOutput;
142
+ };
143
+ };
144
+ }
@@ -0,0 +1,109 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient";
4
+ import { GetChannelNamespaceRequest, GetChannelNamespaceResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetChannelNamespaceCommand}.
14
+ */
15
+ export interface GetChannelNamespaceCommandInput extends GetChannelNamespaceRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetChannelNamespaceCommand}.
21
+ */
22
+ export interface GetChannelNamespaceCommandOutput extends GetChannelNamespaceResponse, __MetadataBearer {
23
+ }
24
+ declare const GetChannelNamespaceCommand_base: {
25
+ new (input: GetChannelNamespaceCommandInput): import("@smithy/smithy-client").CommandImpl<GetChannelNamespaceCommandInput, GetChannelNamespaceCommandOutput, AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetChannelNamespaceCommandInput): import("@smithy/smithy-client").CommandImpl<GetChannelNamespaceCommandInput, GetChannelNamespaceCommandOutput, AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves the channel namespace for a specified <code>Api</code>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { AppSyncClient, GetChannelNamespaceCommand } from "@aws-sdk/client-appsync"; // ES Modules import
35
+ * // const { AppSyncClient, GetChannelNamespaceCommand } = require("@aws-sdk/client-appsync"); // CommonJS import
36
+ * const client = new AppSyncClient(config);
37
+ * const input = { // GetChannelNamespaceRequest
38
+ * apiId: "STRING_VALUE", // required
39
+ * name: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetChannelNamespaceCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetChannelNamespaceResponse
44
+ * // channelNamespace: { // ChannelNamespace
45
+ * // apiId: "STRING_VALUE",
46
+ * // name: "STRING_VALUE",
47
+ * // subscribeAuthModes: [ // AuthModes
48
+ * // { // AuthMode
49
+ * // authType: "API_KEY" || "AWS_IAM" || "AMAZON_COGNITO_USER_POOLS" || "OPENID_CONNECT" || "AWS_LAMBDA", // required
50
+ * // },
51
+ * // ],
52
+ * // publishAuthModes: [
53
+ * // {
54
+ * // authType: "API_KEY" || "AWS_IAM" || "AMAZON_COGNITO_USER_POOLS" || "OPENID_CONNECT" || "AWS_LAMBDA", // required
55
+ * // },
56
+ * // ],
57
+ * // codeHandlers: "STRING_VALUE",
58
+ * // tags: { // TagMap
59
+ * // "<keys>": "STRING_VALUE",
60
+ * // },
61
+ * // channelNamespaceArn: "STRING_VALUE",
62
+ * // created: new Date("TIMESTAMP"),
63
+ * // lastModified: new Date("TIMESTAMP"),
64
+ * // },
65
+ * // };
66
+ *
67
+ * ```
68
+ *
69
+ * @param GetChannelNamespaceCommandInput - {@link GetChannelNamespaceCommandInput}
70
+ * @returns {@link GetChannelNamespaceCommandOutput}
71
+ * @see {@link GetChannelNamespaceCommandInput} for command's `input` shape.
72
+ * @see {@link GetChannelNamespaceCommandOutput} for command's `response` shape.
73
+ * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
74
+ *
75
+ * @throws {@link AccessDeniedException} (client fault)
76
+ * <p>You don't have access to perform this operation on this resource.</p>
77
+ *
78
+ * @throws {@link BadRequestException} (client fault)
79
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
80
+ * missing. Check the field values, and then try again.</p>
81
+ *
82
+ * @throws {@link InternalFailureException} (server fault)
83
+ * <p>An internal AppSync error occurred. Try your request again.</p>
84
+ *
85
+ * @throws {@link NotFoundException} (client fault)
86
+ * <p>The resource specified in the request was not found. Check the resource, and then try
87
+ * again.</p>
88
+ *
89
+ * @throws {@link UnauthorizedException} (client fault)
90
+ * <p>You aren't authorized to perform this operation.</p>
91
+ *
92
+ * @throws {@link AppSyncServiceException}
93
+ * <p>Base exception class for all service exceptions from AppSync service.</p>
94
+ *
95
+ * @public
96
+ */
97
+ export declare class GetChannelNamespaceCommand extends GetChannelNamespaceCommand_base {
98
+ /** @internal type navigation helper, not in runtime. */
99
+ protected static __types: {
100
+ api: {
101
+ input: GetChannelNamespaceRequest;
102
+ output: GetChannelNamespaceResponse;
103
+ };
104
+ sdk: {
105
+ input: GetChannelNamespaceCommandInput;
106
+ output: GetChannelNamespaceCommandOutput;
107
+ };
108
+ };
109
+ }
@@ -105,18 +105,19 @@ declare const GetDataSourceCommand_base: {
105
105
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
106
106
  *
107
107
  * @throws {@link BadRequestException} (client fault)
108
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
109
- * field values, and then try again.</p>
108
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
109
+ * missing. Check the field values, and then try again.</p>
110
110
  *
111
111
  * @throws {@link ConcurrentModificationException} (client fault)
112
- * <p>Another modification is in progress at this time and it must complete before you can make your
113
- * change.</p>
112
+ * <p>Another modification is in progress at this time and it must complete before you can
113
+ * make your change.</p>
114
114
  *
115
115
  * @throws {@link InternalFailureException} (server fault)
116
116
  * <p>An internal AppSync error occurred. Try your request again.</p>
117
117
  *
118
118
  * @throws {@link NotFoundException} (client fault)
119
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
119
+ * <p>The resource specified in the request was not found. Check the resource, and then try
120
+ * again.</p>
120
121
  *
121
122
  * @throws {@link UnauthorizedException} (client fault)
122
123
  * <p>You aren't authorized to perform this operation.</p>
@@ -27,9 +27,9 @@ declare const GetDataSourceIntrospectionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves the record of an existing introspection. If the retrieval is successful, the result of the
31
- * instrospection will also be returned. If the retrieval fails the operation, an error message will be returned
32
- * instead.</p>
30
+ * <p>Retrieves the record of an existing introspection. If the retrieval is successful, the
31
+ * result of the instrospection will also be returned. If the retrieval fails the operation,
32
+ * an error message will be returned instead.</p>
33
33
  * @example
34
34
  * Use a bare-bones client and the command you need to make an API call.
35
35
  * ```javascript
@@ -103,14 +103,15 @@ declare const GetDataSourceIntrospectionCommand_base: {
103
103
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
104
104
  *
105
105
  * @throws {@link BadRequestException} (client fault)
106
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
107
- * field values, and then try again.</p>
106
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
107
+ * missing. Check the field values, and then try again.</p>
108
108
  *
109
109
  * @throws {@link InternalFailureException} (server fault)
110
110
  * <p>An internal AppSync error occurred. Try your request again.</p>
111
111
  *
112
112
  * @throws {@link NotFoundException} (client fault)
113
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
113
+ * <p>The resource specified in the request was not found. Check the resource, and then try
114
+ * again.</p>
114
115
  *
115
116
  * @throws {@link AppSyncServiceException}
116
117
  * <p>Base exception class for all service exceptions from AppSync service.</p>
@@ -61,14 +61,15 @@ declare const GetDomainNameCommand_base: {
61
61
  * <p>You don't have access to perform this operation on this resource.</p>
62
62
  *
63
63
  * @throws {@link BadRequestException} (client fault)
64
- * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
65
- * field values, and then try again.</p>
64
+ * <p>The request is not well formed. For example, a value is invalid or a required field is
65
+ * missing. Check the field values, and then try again.</p>
66
66
  *
67
67
  * @throws {@link InternalFailureException} (server fault)
68
68
  * <p>An internal AppSync error occurred. Try your request again.</p>
69
69
  *
70
70
  * @throws {@link NotFoundException} (client fault)
71
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
71
+ * <p>The resource specified in the request was not found. Check the resource, and then try
72
+ * again.</p>
72
73
  *
73
74
  * @throws {@link AppSyncServiceException}
74
75
  * <p>Base exception class for all service exceptions from AppSync service.</p>
@@ -75,11 +75,12 @@ declare const GetFunctionCommand_base: {
75
75
  * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape.
76
76
  *
77
77
  * @throws {@link ConcurrentModificationException} (client fault)
78
- * <p>Another modification is in progress at this time and it must complete before you can make your
79
- * change.</p>
78
+ * <p>Another modification is in progress at this time and it must complete before you can
79
+ * make your change.</p>
80
80
  *
81
81
  * @throws {@link NotFoundException} (client fault)
82
- * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
82
+ * <p>The resource specified in the request was not found. Check the resource, and then try
83
+ * again.</p>
83
84
  *
84
85
  * @throws {@link UnauthorizedException} (client fault)
85
86
  * <p>You aren't authorized to perform this operation.</p>