@aws-sdk/client-appsync 3.679.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.
- package/README.md +90 -10
- package/dist-cjs/index.js +572 -0
- package/dist-es/AppSync.js +20 -0
- package/dist-es/commands/CreateApiCommand.js +22 -0
- package/dist-es/commands/CreateChannelNamespaceCommand.js +22 -0
- package/dist-es/commands/DeleteApiCommand.js +22 -0
- package/dist-es/commands/DeleteChannelNamespaceCommand.js +22 -0
- package/dist-es/commands/GetApiCommand.js +22 -0
- package/dist-es/commands/GetChannelNamespaceCommand.js +22 -0
- package/dist-es/commands/ListApisCommand.js +22 -0
- package/dist-es/commands/ListChannelNamespacesCommand.js +22 -0
- package/dist-es/commands/UpdateApiCommand.js +22 -0
- package/dist-es/commands/UpdateChannelNamespaceCommand.js +22 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/models/models_0.js +31 -0
- package/dist-es/pagination/ListApisPaginator.js +4 -0
- package/dist-es/pagination/ListChannelNamespacesPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +341 -2
- package/dist-types/AppSync.d.ts +73 -2
- package/dist-types/AppSyncClient.d.ts +14 -4
- package/dist-types/commands/AssociateApiCommand.d.ts +4 -3
- package/dist-types/commands/AssociateMergedGraphqlApiCommand.d.ts +8 -6
- package/dist-types/commands/AssociateSourceGraphqlApiCommand.d.ts +8 -6
- package/dist-types/commands/CreateApiCacheCommand.d.ts +6 -5
- package/dist-types/commands/CreateApiCommand.d.ts +192 -0
- package/dist-types/commands/CreateApiKeyCommand.d.ts +4 -3
- package/dist-types/commands/CreateChannelNamespaceCommand.d.ts +133 -0
- package/dist-types/commands/CreateDataSourceCommand.d.ts +6 -5
- package/dist-types/commands/CreateDomainNameCommand.d.ts +2 -2
- package/dist-types/commands/CreateFunctionCommand.d.ts +8 -6
- package/dist-types/commands/CreateGraphqlApiCommand.d.ts +5 -5
- package/dist-types/commands/CreateResolverCommand.d.ts +8 -7
- package/dist-types/commands/CreateTypeCommand.d.ts +6 -5
- package/dist-types/commands/DeleteApiCacheCommand.d.ts +6 -5
- package/dist-types/commands/DeleteApiCommand.d.ts +90 -0
- package/dist-types/commands/DeleteApiKeyCommand.d.ts +4 -3
- package/dist-types/commands/DeleteChannelNamespaceCommand.d.ts +91 -0
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +6 -5
- package/dist-types/commands/DeleteDomainNameCommand.d.ts +6 -5
- package/dist-types/commands/DeleteFunctionCommand.d.ts +6 -5
- package/dist-types/commands/DeleteGraphqlApiCommand.d.ts +6 -5
- package/dist-types/commands/DeleteResolverCommand.d.ts +6 -5
- package/dist-types/commands/DeleteTypeCommand.d.ts +6 -5
- package/dist-types/commands/DisassociateApiCommand.d.ts +6 -5
- package/dist-types/commands/DisassociateMergedGraphqlApiCommand.d.ts +8 -7
- package/dist-types/commands/DisassociateSourceGraphqlApiCommand.d.ts +8 -7
- package/dist-types/commands/EvaluateCodeCommand.d.ts +8 -7
- package/dist-types/commands/EvaluateMappingTemplateCommand.d.ts +8 -7
- package/dist-types/commands/FlushApiCacheCommand.d.ts +6 -5
- package/dist-types/commands/GetApiAssociationCommand.d.ts +4 -3
- package/dist-types/commands/GetApiCacheCommand.d.ts +6 -5
- package/dist-types/commands/GetApiCommand.d.ts +144 -0
- package/dist-types/commands/GetChannelNamespaceCommand.d.ts +109 -0
- package/dist-types/commands/GetDataSourceCommand.d.ts +6 -5
- package/dist-types/commands/GetDataSourceIntrospectionCommand.d.ts +7 -6
- package/dist-types/commands/GetDomainNameCommand.d.ts +4 -3
- package/dist-types/commands/GetFunctionCommand.d.ts +4 -3
- package/dist-types/commands/GetGraphqlApiCommand.d.ts +4 -3
- package/dist-types/commands/GetGraphqlApiEnvironmentVariablesCommand.d.ts +6 -4
- package/dist-types/commands/GetIntrospectionSchemaCommand.d.ts +2 -1
- package/dist-types/commands/GetResolverCommand.d.ts +4 -3
- package/dist-types/commands/GetSchemaCreationStatusCommand.d.ts +4 -3
- package/dist-types/commands/GetSourceApiAssociationCommand.d.ts +4 -3
- package/dist-types/commands/GetTypeCommand.d.ts +6 -5
- package/dist-types/commands/ListApiKeysCommand.d.ts +8 -6
- package/dist-types/commands/ListApisCommand.d.ts +144 -0
- package/dist-types/commands/ListChannelNamespacesCommand.d.ts +114 -0
- package/dist-types/commands/ListDataSourcesCommand.d.ts +4 -3
- package/dist-types/commands/ListDomainNamesCommand.d.ts +2 -2
- package/dist-types/commands/ListFunctionsCommand.d.ts +4 -3
- package/dist-types/commands/ListGraphqlApisCommand.d.ts +2 -2
- package/dist-types/commands/ListResolversByFunctionCommand.d.ts +4 -3
- package/dist-types/commands/ListResolversCommand.d.ts +4 -3
- package/dist-types/commands/ListSourceApiAssociationsCommand.d.ts +4 -3
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -3
- package/dist-types/commands/ListTypesByAssociationCommand.d.ts +6 -5
- package/dist-types/commands/ListTypesCommand.d.ts +6 -5
- package/dist-types/commands/PutGraphqlApiEnvironmentVariablesCommand.d.ts +21 -17
- package/dist-types/commands/StartDataSourceIntrospectionCommand.d.ts +6 -5
- package/dist-types/commands/StartSchemaCreationCommand.d.ts +8 -7
- package/dist-types/commands/StartSchemaMergeCommand.d.ts +8 -6
- package/dist-types/commands/TagResourceCommand.d.ts +4 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -3
- package/dist-types/commands/UpdateApiCacheCommand.d.ts +6 -5
- package/dist-types/commands/UpdateApiCommand.d.ts +192 -0
- package/dist-types/commands/UpdateApiKeyCommand.d.ts +4 -3
- package/dist-types/commands/UpdateChannelNamespaceCommand.d.ts +124 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +6 -5
- package/dist-types/commands/UpdateDomainNameCommand.d.ts +6 -5
- package/dist-types/commands/UpdateFunctionCommand.d.ts +6 -5
- package/dist-types/commands/UpdateGraphqlApiCommand.d.ts +7 -6
- package/dist-types/commands/UpdateResolverCommand.d.ts +6 -5
- package/dist-types/commands/UpdateSourceApiAssociationCommand.d.ts +6 -5
- package/dist-types/commands/UpdateTypeCommand.d.ts +6 -5
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +1305 -629
- package/dist-types/pagination/ListApisPaginator.d.ts +7 -0
- package/dist-types/pagination/ListChannelNamespacesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
- package/dist-types/ts3.4/AppSync.d.ts +171 -0
- package/dist-types/ts3.4/AppSyncClient.d.ts +60 -0
- package/dist-types/ts3.4/commands/CreateApiCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateChannelNamespaceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteApiCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteChannelNamespaceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetApiCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetChannelNamespaceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListApisCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListChannelNamespacesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateApiCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateChannelNamespaceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +148 -2
- package/dist-types/ts3.4/pagination/ListApisPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListChannelNamespacesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +120 -0
- package/package.json +6 -6
|
@@ -28,37 +28,41 @@ export declare const AuthenticationType: {
|
|
|
28
28
|
*/
|
|
29
29
|
export type AuthenticationType = (typeof AuthenticationType)[keyof typeof AuthenticationType];
|
|
30
30
|
/**
|
|
31
|
-
* <p>A <code>LambdaAuthorizerConfig</code> specifies how to authorize AppSync
|
|
32
|
-
* using the <code>AWS_LAMBDA</code> authorizer mode. Be aware that an AppSync API can have only
|
|
33
|
-
*
|
|
31
|
+
* <p>A <code>LambdaAuthorizerConfig</code> specifies how to authorize AppSync
|
|
32
|
+
* API access when using the <code>AWS_LAMBDA</code> authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a
|
|
33
|
+
* time.</p>
|
|
34
34
|
* @public
|
|
35
35
|
*/
|
|
36
36
|
export interface LambdaAuthorizerConfig {
|
|
37
37
|
/**
|
|
38
|
-
* <p>The number of seconds a response should be cached for. The default is 0 seconds, which
|
|
39
|
-
* you don't specify a value for
|
|
40
|
-
*
|
|
41
|
-
*
|
|
38
|
+
* <p>The number of seconds a response should be cached for. The default is 0 seconds, which
|
|
39
|
+
* disables caching. If you don't specify a value for
|
|
40
|
+
* <code>authorizerResultTtlInSeconds</code>, the default value is used. The maximum value
|
|
41
|
+
* is one hour (3600 seconds). The Lambda function can override this by returning
|
|
42
|
+
* a <code>ttlOverride</code> key in its response.</p>
|
|
42
43
|
* @public
|
|
43
44
|
*/
|
|
44
45
|
authorizerResultTtlInSeconds?: number;
|
|
45
46
|
/**
|
|
46
|
-
* <p>The Amazon Resource Name (ARN) of the Lambda function to be called for
|
|
47
|
-
* be a standard Lambda ARN, a version ARN
|
|
47
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function to be called for
|
|
48
|
+
* authorization. This can be a standard Lambda ARN, a version ARN
|
|
49
|
+
* (<code>.../v3</code>), or an alias ARN. </p>
|
|
48
50
|
* <p>
|
|
49
|
-
* <b>Note</b>: This Lambda function must have the
|
|
50
|
-
* resource-based policy assigned to it. When configuring Lambda
|
|
51
|
-
* done for you. To use the Command Line Interface
|
|
51
|
+
* <b>Note</b>: This Lambda function must have the
|
|
52
|
+
* following resource-based policy assigned to it. When configuring Lambda
|
|
53
|
+
* authorizers in the console, this is done for you. To use the Command Line Interface
|
|
54
|
+
* (CLI), run the following:</p>
|
|
52
55
|
* <p>
|
|
53
56
|
* <code>aws lambda add-permission --function-name
|
|
54
|
-
* "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync"
|
|
55
|
-
* appsync.amazonaws.com --action lambda:InvokeFunction</code>
|
|
57
|
+
* "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync"
|
|
58
|
+
* --principal appsync.amazonaws.com --action lambda:InvokeFunction</code>
|
|
56
59
|
* </p>
|
|
57
60
|
* @public
|
|
58
61
|
*/
|
|
59
62
|
authorizerUri: string | undefined;
|
|
60
63
|
/**
|
|
61
|
-
* <p>A regular expression for validation of tokens before the Lambda function is
|
|
64
|
+
* <p>A regular expression for validation of tokens before the Lambda function is
|
|
65
|
+
* called.</p>
|
|
62
66
|
* @public
|
|
63
67
|
*/
|
|
64
68
|
identityValidationExpression?: string;
|
|
@@ -69,15 +73,16 @@ export interface LambdaAuthorizerConfig {
|
|
|
69
73
|
*/
|
|
70
74
|
export interface OpenIDConnectConfig {
|
|
71
75
|
/**
|
|
72
|
-
* <p>The issuer for the OIDC configuration. The issuer returned by discovery must exactly
|
|
73
|
-
*
|
|
76
|
+
* <p>The issuer for the OIDC configuration. The issuer returned by discovery must exactly
|
|
77
|
+
* match the value of <code>iss</code> in the ID token.</p>
|
|
74
78
|
* @public
|
|
75
79
|
*/
|
|
76
80
|
issuer: string | undefined;
|
|
77
81
|
/**
|
|
78
|
-
* <p>The client identifier of the relying party at the OpenID identity provider. This
|
|
79
|
-
* obtained when the relying party is registered with the OpenID
|
|
80
|
-
*
|
|
82
|
+
* <p>The client identifier of the relying party at the OpenID identity provider. This
|
|
83
|
+
* identifier is typically obtained when the relying party is registered with the OpenID
|
|
84
|
+
* identity provider. You can specify a regular expression so that AppSync can
|
|
85
|
+
* validate against multiple client identifiers at a time.</p>
|
|
81
86
|
* @public
|
|
82
87
|
*/
|
|
83
88
|
clientId?: string;
|
|
@@ -108,8 +113,8 @@ export interface CognitoUserPoolConfig {
|
|
|
108
113
|
*/
|
|
109
114
|
awsRegion: string | undefined;
|
|
110
115
|
/**
|
|
111
|
-
* <p>A regular expression for validating the incoming Amazon Cognito user pool app client
|
|
112
|
-
* isn't set, no filtering is applied.</p>
|
|
116
|
+
* <p>A regular expression for validating the incoming Amazon Cognito user pool app client
|
|
117
|
+
* ID. If this value isn't set, no filtering is applied.</p>
|
|
113
118
|
* @public
|
|
114
119
|
*/
|
|
115
120
|
appIdClientRegex?: string;
|
|
@@ -120,8 +125,8 @@ export interface CognitoUserPoolConfig {
|
|
|
120
125
|
*/
|
|
121
126
|
export interface AdditionalAuthenticationProvider {
|
|
122
127
|
/**
|
|
123
|
-
* <p>The authentication type: API key, Identity and Access Management (IAM), OpenID
|
|
124
|
-
*
|
|
128
|
+
* <p>The authentication type: API key, Identity and Access Management (IAM), OpenID
|
|
129
|
+
* Connect (OIDC), Amazon Cognito user pools, or Lambda.</p>
|
|
125
130
|
* @public
|
|
126
131
|
*/
|
|
127
132
|
authenticationType?: AuthenticationType;
|
|
@@ -141,6 +146,194 @@ export interface AdditionalAuthenticationProvider {
|
|
|
141
146
|
*/
|
|
142
147
|
lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
|
|
143
148
|
}
|
|
149
|
+
/**
|
|
150
|
+
* <p>Describes an Amazon Cognito configuration.</p>
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
export interface CognitoConfig {
|
|
154
|
+
/**
|
|
155
|
+
* <p>The user pool ID.</p>
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
userPoolId: string | undefined;
|
|
159
|
+
/**
|
|
160
|
+
* <p>The Amazon Web Services Region in which the user pool was created.</p>
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
awsRegion: string | undefined;
|
|
164
|
+
/**
|
|
165
|
+
* <p>A regular expression for validating the incoming Amazon Cognito user pool app client
|
|
166
|
+
* ID. If this value isn't set, no filtering is applied.</p>
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
appIdClientRegex?: string;
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* <p>Describes an authorization provider.</p>
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
export interface AuthProvider {
|
|
176
|
+
/**
|
|
177
|
+
* <p>The authorization type.</p>
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
authType: AuthenticationType | undefined;
|
|
181
|
+
/**
|
|
182
|
+
* <p>Describes an Amazon Cognito user pool configuration.</p>
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
cognitoConfig?: CognitoConfig;
|
|
186
|
+
/**
|
|
187
|
+
* <p>Describes an OpenID Connect (OIDC) configuration.</p>
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
openIDConnectConfig?: OpenIDConnectConfig;
|
|
191
|
+
/**
|
|
192
|
+
* <p>A <code>LambdaAuthorizerConfig</code> specifies how to authorize AppSync
|
|
193
|
+
* API access when using the <code>AWS_LAMBDA</code> authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a
|
|
194
|
+
* time.</p>
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
197
|
+
lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* <p>Describes an authorization configuration. Use <code>AuthMode</code> to specify the
|
|
201
|
+
* publishing and subscription authorization configuration for an Event API.</p>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
export interface AuthMode {
|
|
205
|
+
/**
|
|
206
|
+
* <p>The authorization type.</p>
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
authType: AuthenticationType | undefined;
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* @public
|
|
213
|
+
* @enum
|
|
214
|
+
*/
|
|
215
|
+
export declare const EventLogLevel: {
|
|
216
|
+
readonly ALL: "ALL";
|
|
217
|
+
readonly DEBUG: "DEBUG";
|
|
218
|
+
readonly ERROR: "ERROR";
|
|
219
|
+
readonly INFO: "INFO";
|
|
220
|
+
readonly NONE: "NONE";
|
|
221
|
+
};
|
|
222
|
+
/**
|
|
223
|
+
* @public
|
|
224
|
+
*/
|
|
225
|
+
export type EventLogLevel = (typeof EventLogLevel)[keyof typeof EventLogLevel];
|
|
226
|
+
/**
|
|
227
|
+
* <p>Describes the CloudWatch Logs configuration for the Event API.</p>
|
|
228
|
+
* @public
|
|
229
|
+
*/
|
|
230
|
+
export interface EventLogConfig {
|
|
231
|
+
/**
|
|
232
|
+
* <p>The type of information to log for the Event API. </p>
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
235
|
+
logLevel: EventLogLevel | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* <p>The IAM service role that AppSync assumes to publish CloudWatch Logs in your account.</p>
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
240
|
+
cloudWatchLogsRoleArn: string | undefined;
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* <p>Describes the authorization configuration for connections, message publishing, message
|
|
244
|
+
* subscriptions, and logging for an Event API.</p>
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
export interface EventConfig {
|
|
248
|
+
/**
|
|
249
|
+
* <p>A list of authorization providers.</p>
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
252
|
+
authProviders: AuthProvider[] | undefined;
|
|
253
|
+
/**
|
|
254
|
+
* <p>A list of valid authorization modes for the Event API connections.</p>
|
|
255
|
+
* @public
|
|
256
|
+
*/
|
|
257
|
+
connectionAuthModes: AuthMode[] | undefined;
|
|
258
|
+
/**
|
|
259
|
+
* <p>A list of valid authorization modes for the Event API publishing.</p>
|
|
260
|
+
* @public
|
|
261
|
+
*/
|
|
262
|
+
defaultPublishAuthModes: AuthMode[] | undefined;
|
|
263
|
+
/**
|
|
264
|
+
* <p>A list of valid authorization modes for the Event API subscriptions.</p>
|
|
265
|
+
* @public
|
|
266
|
+
*/
|
|
267
|
+
defaultSubscribeAuthModes: AuthMode[] | undefined;
|
|
268
|
+
/**
|
|
269
|
+
* <p>The CloudWatch Logs configuration for the Event API.</p>
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
logConfig?: EventLogConfig;
|
|
273
|
+
}
|
|
274
|
+
/**
|
|
275
|
+
* <p>Describes an AppSync API. You can use <code>Api</code> for an AppSync
|
|
276
|
+
* API with your preferred configuration, such as an Event API that provides real-time message
|
|
277
|
+
* publishing and message subscriptions over WebSockets.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
export interface Api {
|
|
281
|
+
/**
|
|
282
|
+
* <p>The <code>Api</code> ID.</p>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
apiId?: string;
|
|
286
|
+
/**
|
|
287
|
+
* <p>The name of the <code>Api</code>.</p>
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
name?: string;
|
|
291
|
+
/**
|
|
292
|
+
* <p>The owner contact information for the <code>Api</code>
|
|
293
|
+
* </p>
|
|
294
|
+
* @public
|
|
295
|
+
*/
|
|
296
|
+
ownerContact?: string;
|
|
297
|
+
/**
|
|
298
|
+
* <p>A map with keys of <code>TagKey</code> objects and values of <code>TagValue</code>
|
|
299
|
+
* objects.</p>
|
|
300
|
+
* @public
|
|
301
|
+
*/
|
|
302
|
+
tags?: Record<string, string>;
|
|
303
|
+
/**
|
|
304
|
+
* <p>The DNS records for the API. This will include an HTTP and a real-time endpoint.</p>
|
|
305
|
+
* @public
|
|
306
|
+
*/
|
|
307
|
+
dns?: Record<string, string>;
|
|
308
|
+
/**
|
|
309
|
+
* <p>The Amazon Resource Name (ARN) for the <code>Api</code>.</p>
|
|
310
|
+
* @public
|
|
311
|
+
*/
|
|
312
|
+
apiArn?: string;
|
|
313
|
+
/**
|
|
314
|
+
* <p>The date and time that the <code>Api</code> was created.</p>
|
|
315
|
+
* @public
|
|
316
|
+
*/
|
|
317
|
+
created?: Date;
|
|
318
|
+
/**
|
|
319
|
+
* <p>A flag indicating whether to use X-Ray tracing for this
|
|
320
|
+
* <code>Api</code>.</p>
|
|
321
|
+
* @public
|
|
322
|
+
*/
|
|
323
|
+
xrayEnabled?: boolean;
|
|
324
|
+
/**
|
|
325
|
+
* <p>The Amazon Resource Name (ARN) of the WAF web access control list (web
|
|
326
|
+
* ACL) associated with this <code>Api</code>, if one exists.</p>
|
|
327
|
+
* @public
|
|
328
|
+
*/
|
|
329
|
+
wafWebAclArn?: string;
|
|
330
|
+
/**
|
|
331
|
+
* <p>The Event API configuration. This includes the default authorization configuration for
|
|
332
|
+
* connecting, publishing, and subscribing to an Event API.</p>
|
|
333
|
+
* @public
|
|
334
|
+
*/
|
|
335
|
+
eventConfig?: EventConfig;
|
|
336
|
+
}
|
|
144
337
|
/**
|
|
145
338
|
* @public
|
|
146
339
|
* @enum
|
|
@@ -174,18 +367,18 @@ export interface ApiAssociation {
|
|
|
174
367
|
* <ul>
|
|
175
368
|
* <li>
|
|
176
369
|
* <p>
|
|
177
|
-
* <b>PROCESSING</b>: The API association is being
|
|
178
|
-
* modify association requests during processing.</p>
|
|
370
|
+
* <b>PROCESSING</b>: The API association is being
|
|
371
|
+
* created. You cannot modify association requests during processing.</p>
|
|
179
372
|
* </li>
|
|
180
373
|
* <li>
|
|
181
374
|
* <p>
|
|
182
|
-
* <b>SUCCESS</b>: The API association was successful.
|
|
183
|
-
* associations after success.</p>
|
|
375
|
+
* <b>SUCCESS</b>: The API association was successful.
|
|
376
|
+
* You can modify associations after success.</p>
|
|
184
377
|
* </li>
|
|
185
378
|
* <li>
|
|
186
379
|
* <p>
|
|
187
|
-
* <b>FAILED</b>: The API association has failed. You
|
|
188
|
-
* associations after failure.</p>
|
|
380
|
+
* <b>FAILED</b>: The API association has failed. You
|
|
381
|
+
* can modify associations after failure.</p>
|
|
189
382
|
* </li>
|
|
190
383
|
* </ul>
|
|
191
384
|
* @public
|
|
@@ -277,19 +470,21 @@ export interface ApiCache {
|
|
|
277
470
|
* <ul>
|
|
278
471
|
* <li>
|
|
279
472
|
* <p>
|
|
280
|
-
* <b>FULL_REQUEST_CACHING</b>: All requests are fully
|
|
473
|
+
* <b>FULL_REQUEST_CACHING</b>: All requests are fully
|
|
474
|
+
* cached.</p>
|
|
281
475
|
* </li>
|
|
282
476
|
* <li>
|
|
283
477
|
* <p>
|
|
284
|
-
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers
|
|
285
|
-
* cached.</p>
|
|
478
|
+
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers
|
|
479
|
+
* that you specify are cached.</p>
|
|
286
480
|
* </li>
|
|
287
481
|
* </ul>
|
|
288
482
|
* @public
|
|
289
483
|
*/
|
|
290
484
|
apiCachingBehavior?: ApiCachingBehavior;
|
|
291
485
|
/**
|
|
292
|
-
* <p>Transit encryption flag when connecting to cache. You cannot update this setting after
|
|
486
|
+
* <p>Transit encryption flag when connecting to cache. You cannot update this setting after
|
|
487
|
+
* creation.</p>
|
|
293
488
|
* @public
|
|
294
489
|
*/
|
|
295
490
|
transitEncryptionEnabled?: boolean;
|
|
@@ -381,55 +576,63 @@ export interface ApiCache {
|
|
|
381
576
|
* <ul>
|
|
382
577
|
* <li>
|
|
383
578
|
* <p>
|
|
384
|
-
* <b>AVAILABLE</b>: The instance is available for
|
|
579
|
+
* <b>AVAILABLE</b>: The instance is available for
|
|
580
|
+
* use.</p>
|
|
385
581
|
* </li>
|
|
386
582
|
* <li>
|
|
387
583
|
* <p>
|
|
388
|
-
* <b>CREATING</b>: The instance is currently
|
|
584
|
+
* <b>CREATING</b>: The instance is currently
|
|
585
|
+
* creating.</p>
|
|
389
586
|
* </li>
|
|
390
587
|
* <li>
|
|
391
588
|
* <p>
|
|
392
|
-
* <b>DELETING</b>: The instance is currently
|
|
589
|
+
* <b>DELETING</b>: The instance is currently
|
|
590
|
+
* deleting.</p>
|
|
393
591
|
* </li>
|
|
394
592
|
* <li>
|
|
395
593
|
* <p>
|
|
396
|
-
* <b>MODIFYING</b>: The instance is currently
|
|
594
|
+
* <b>MODIFYING</b>: The instance is currently
|
|
595
|
+
* modifying.</p>
|
|
397
596
|
* </li>
|
|
398
597
|
* <li>
|
|
399
598
|
* <p>
|
|
400
|
-
* <b>FAILED</b>: The instance has failed
|
|
599
|
+
* <b>FAILED</b>: The instance has failed
|
|
600
|
+
* creation.</p>
|
|
401
601
|
* </li>
|
|
402
602
|
* </ul>
|
|
403
603
|
* @public
|
|
404
604
|
*/
|
|
405
605
|
status?: ApiCacheStatus;
|
|
406
606
|
/**
|
|
407
|
-
* <p>Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics
|
|
607
|
+
* <p>Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics
|
|
608
|
+
* include:</p>
|
|
408
609
|
* <ul>
|
|
409
610
|
* <li>
|
|
410
|
-
* <p>NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the
|
|
411
|
-
* the aggregated bandwidth limit. This is useful for diagnosing
|
|
412
|
-
* configuration.</p>
|
|
611
|
+
* <p>NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the
|
|
612
|
+
* throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing
|
|
613
|
+
* bottlenecks in a cache configuration.</p>
|
|
413
614
|
* </li>
|
|
414
615
|
* <li>
|
|
415
|
-
* <p>EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis
|
|
416
|
-
* useful for diagnosing bottlenecks in a cache
|
|
616
|
+
* <p>EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis
|
|
617
|
+
* process. This is useful for diagnosing bottlenecks in a cache
|
|
618
|
+
* configuration.</p>
|
|
417
619
|
* </li>
|
|
418
620
|
* </ul>
|
|
419
621
|
* <p>Metrics will be recorded by API ID. You can set the value to <code>ENABLED</code> or
|
|
420
|
-
*
|
|
622
|
+
* <code>DISABLED</code>.</p>
|
|
421
623
|
* @public
|
|
422
624
|
*/
|
|
423
625
|
healthMetricsConfig?: CacheHealthMetricsConfig;
|
|
424
626
|
}
|
|
425
627
|
/**
|
|
426
628
|
* <p>Describes an API key.</p>
|
|
427
|
-
* <p>Customers invoke AppSync GraphQL API operations with API keys as an
|
|
428
|
-
* There are two key versions:</p>
|
|
629
|
+
* <p>Customers invoke AppSync GraphQL API operations with API keys as an
|
|
630
|
+
* identity mechanism. There are two key versions:</p>
|
|
429
631
|
* <p>
|
|
430
|
-
* <b>da1</b>: We introduced this version at launch in November
|
|
431
|
-
* always expire after 7 days. Amazon DynamoDB TTL manages key
|
|
432
|
-
* after February 21, 2018, and they should no
|
|
632
|
+
* <b>da1</b>: We introduced this version at launch in November
|
|
633
|
+
* 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key
|
|
634
|
+
* expiration. These keys ceased to be valid after February 21, 2018, and they should no
|
|
635
|
+
* longer be used.</p>
|
|
433
636
|
* <ul>
|
|
434
637
|
* <li>
|
|
435
638
|
* <p>
|
|
@@ -437,7 +640,8 @@ export interface ApiCache {
|
|
|
437
640
|
* </li>
|
|
438
641
|
* <li>
|
|
439
642
|
* <p>
|
|
440
|
-
* <code>CreateApiKey</code> returns the expiration time in
|
|
643
|
+
* <code>CreateApiKey</code> returns the expiration time in
|
|
644
|
+
* milliseconds.</p>
|
|
441
645
|
* </li>
|
|
442
646
|
* <li>
|
|
443
647
|
* <p>
|
|
@@ -448,40 +652,45 @@ export interface ApiCache {
|
|
|
448
652
|
* <code>DeleteApiKey</code> deletes the item from the table.</p>
|
|
449
653
|
* </li>
|
|
450
654
|
* <li>
|
|
451
|
-
* <p>Expiration is stored in DynamoDB as milliseconds. This results in a
|
|
452
|
-
* not automatically deleted because DynamoDB expects the
|
|
453
|
-
* one-time action, we deleted these keys from the
|
|
655
|
+
* <p>Expiration is stored in DynamoDB as milliseconds. This results in a
|
|
656
|
+
* bug where keys are not automatically deleted because DynamoDB expects the
|
|
657
|
+
* TTL to be stored in seconds. As a one-time action, we deleted these keys from the
|
|
658
|
+
* table on February 21, 2018.</p>
|
|
454
659
|
* </li>
|
|
455
660
|
* </ul>
|
|
456
661
|
* <p>
|
|
457
|
-
* <b>da2</b>: We introduced this version in February 2018 when
|
|
662
|
+
* <b>da2</b>: We introduced this version in February 2018 when
|
|
663
|
+
* AppSync added support to extend key expiration.</p>
|
|
458
664
|
* <ul>
|
|
459
665
|
* <li>
|
|
460
666
|
* <p>
|
|
461
|
-
* <code>ListApiKeys</code> returns the expiration time and deletion time in
|
|
667
|
+
* <code>ListApiKeys</code> returns the expiration time and deletion time in
|
|
668
|
+
* seconds.</p>
|
|
462
669
|
* </li>
|
|
463
670
|
* <li>
|
|
464
671
|
* <p>
|
|
465
|
-
* <code>CreateApiKey</code> returns the expiration time and deletion time in
|
|
466
|
-
* user-provided expiration time in seconds.</p>
|
|
672
|
+
* <code>CreateApiKey</code> returns the expiration time and deletion time in
|
|
673
|
+
* seconds and accepts a user-provided expiration time in seconds.</p>
|
|
467
674
|
* </li>
|
|
468
675
|
* <li>
|
|
469
676
|
* <p>
|
|
470
|
-
* <code>UpdateApiKey</code> returns the expiration time and and deletion time in
|
|
471
|
-
* a user-provided expiration time in seconds. Expired API keys are
|
|
472
|
-
* time. You can update the key expiration time as
|
|
677
|
+
* <code>UpdateApiKey</code> returns the expiration time and and deletion time in
|
|
678
|
+
* seconds and accepts a user-provided expiration time in seconds. Expired API keys are
|
|
679
|
+
* kept for 60 days after the expiration time. You can update the key expiration time as
|
|
680
|
+
* long as the key isn't deleted.</p>
|
|
473
681
|
* </li>
|
|
474
682
|
* <li>
|
|
475
683
|
* <p>
|
|
476
684
|
* <code>DeleteApiKey</code> deletes the item from the table.</p>
|
|
477
685
|
* </li>
|
|
478
686
|
* <li>
|
|
479
|
-
* <p>Expiration is stored in DynamoDB as seconds. After the expiration
|
|
480
|
-
* authenticate will fail. However, you can reinstate the key
|
|
687
|
+
* <p>Expiration is stored in DynamoDB as seconds. After the expiration
|
|
688
|
+
* time, using the key to authenticate will fail. However, you can reinstate the key
|
|
689
|
+
* before deletion.</p>
|
|
481
690
|
* </li>
|
|
482
691
|
* <li>
|
|
483
|
-
* <p>Deletion is stored in DynamoDB as seconds. The key is deleted after
|
|
484
|
-
* time.</p>
|
|
692
|
+
* <p>Deletion is stored in DynamoDB as seconds. The key is deleted after
|
|
693
|
+
* deletion time.</p>
|
|
485
694
|
* </li>
|
|
486
695
|
* </ul>
|
|
487
696
|
* @public
|
|
@@ -498,14 +707,14 @@ export interface ApiKey {
|
|
|
498
707
|
*/
|
|
499
708
|
description?: string;
|
|
500
709
|
/**
|
|
501
|
-
* <p>The time after which the API key expires. The date is represented as seconds since the
|
|
502
|
-
* to the nearest hour.</p>
|
|
710
|
+
* <p>The time after which the API key expires. The date is represented as seconds since the
|
|
711
|
+
* epoch, rounded down to the nearest hour.</p>
|
|
503
712
|
* @public
|
|
504
713
|
*/
|
|
505
714
|
expires?: number;
|
|
506
715
|
/**
|
|
507
|
-
* <p>The time after which the API key is deleted. The date is represented as seconds since
|
|
508
|
-
* down to the nearest hour.</p>
|
|
716
|
+
* <p>The time after which the API key is deleted. The date is represented as seconds since
|
|
717
|
+
* the epoch, rounded down to the nearest hour.</p>
|
|
509
718
|
* @public
|
|
510
719
|
*/
|
|
511
720
|
deletes?: number;
|
|
@@ -559,21 +768,20 @@ export declare const RuntimeName: {
|
|
|
559
768
|
*/
|
|
560
769
|
export type RuntimeName = (typeof RuntimeName)[keyof typeof RuntimeName];
|
|
561
770
|
/**
|
|
562
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
563
|
-
*
|
|
564
|
-
* also be specified.</p>
|
|
771
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
|
|
772
|
+
* that if a runtime is specified, code must also be specified.</p>
|
|
565
773
|
* @public
|
|
566
774
|
*/
|
|
567
775
|
export interface AppSyncRuntime {
|
|
568
776
|
/**
|
|
569
777
|
* <p>The <code>name</code> of the runtime to use. Currently, the only allowed value is
|
|
570
|
-
*
|
|
778
|
+
* <code>APPSYNC_JS</code>.</p>
|
|
571
779
|
* @public
|
|
572
780
|
*/
|
|
573
781
|
name: RuntimeName | undefined;
|
|
574
782
|
/**
|
|
575
783
|
* <p>The <code>version</code> of the runtime to use. Currently, the only allowed version is
|
|
576
|
-
*
|
|
784
|
+
* <code>1.0.0</code>.</p>
|
|
577
785
|
* @public
|
|
578
786
|
*/
|
|
579
787
|
runtimeVersion: string | undefined;
|
|
@@ -631,13 +839,15 @@ export interface CodeErrorLocation {
|
|
|
631
839
|
export interface CodeError {
|
|
632
840
|
/**
|
|
633
841
|
* <p>The type of code error. </p>
|
|
634
|
-
* <p>Examples include, but aren't limited to: <code>LINT_ERROR</code>,
|
|
842
|
+
* <p>Examples include, but aren't limited to: <code>LINT_ERROR</code>,
|
|
843
|
+
* <code>PARSER_ERROR</code>.</p>
|
|
635
844
|
* @public
|
|
636
845
|
*/
|
|
637
846
|
errorType?: string;
|
|
638
847
|
/**
|
|
639
848
|
* <p>A user presentable error.</p>
|
|
640
|
-
* <p>Examples include, but aren't limited to: <code>Parsing error: Unterminated string
|
|
849
|
+
* <p>Examples include, but aren't limited to: <code>Parsing error: Unterminated string
|
|
850
|
+
* literal</code>.</p>
|
|
641
851
|
* @public
|
|
642
852
|
*/
|
|
643
853
|
value?: string;
|
|
@@ -648,8 +858,8 @@ export interface CodeError {
|
|
|
648
858
|
location?: CodeErrorLocation;
|
|
649
859
|
}
|
|
650
860
|
/**
|
|
651
|
-
* <p>Provides further details for the reason behind the bad request. For reason type
|
|
652
|
-
*
|
|
861
|
+
* <p>Provides further details for the reason behind the bad request. For reason type
|
|
862
|
+
* <code>CODE_ERROR</code>, the detail will contain a list of code errors.</p>
|
|
653
863
|
* @public
|
|
654
864
|
*/
|
|
655
865
|
export interface BadRequestDetail {
|
|
@@ -671,8 +881,8 @@ export declare const BadRequestReason: {
|
|
|
671
881
|
*/
|
|
672
882
|
export type BadRequestReason = (typeof BadRequestReason)[keyof typeof BadRequestReason];
|
|
673
883
|
/**
|
|
674
|
-
* <p>The request is not well formed. For example, a value is invalid or a required field is
|
|
675
|
-
* field values, and then try again.</p>
|
|
884
|
+
* <p>The request is not well formed. For example, a value is invalid or a required field is
|
|
885
|
+
* missing. Check the field values, and then try again.</p>
|
|
676
886
|
* @public
|
|
677
887
|
*/
|
|
678
888
|
export declare class BadRequestException extends __BaseException {
|
|
@@ -680,13 +890,13 @@ export declare class BadRequestException extends __BaseException {
|
|
|
680
890
|
readonly $fault: "client";
|
|
681
891
|
/**
|
|
682
892
|
* <p>Provides context for the cause of the bad request. The only supported value is
|
|
683
|
-
*
|
|
893
|
+
* <code>CODE_ERROR</code>.</p>
|
|
684
894
|
* @public
|
|
685
895
|
*/
|
|
686
896
|
reason?: BadRequestReason;
|
|
687
897
|
/**
|
|
688
|
-
* <p>Provides further details for the reason behind the bad request. For reason type
|
|
689
|
-
*
|
|
898
|
+
* <p>Provides further details for the reason behind the bad request. For reason type
|
|
899
|
+
* <code>CODE_ERROR</code>, the detail will contain a list of code errors.</p>
|
|
690
900
|
* @public
|
|
691
901
|
*/
|
|
692
902
|
detail?: BadRequestDetail;
|
|
@@ -708,7 +918,8 @@ export declare class InternalFailureException extends __BaseException {
|
|
|
708
918
|
constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
|
|
709
919
|
}
|
|
710
920
|
/**
|
|
711
|
-
* <p>The resource specified in the request was not found. Check the resource, and then try
|
|
921
|
+
* <p>The resource specified in the request was not found. Check the resource, and then try
|
|
922
|
+
* again.</p>
|
|
712
923
|
* @public
|
|
713
924
|
*/
|
|
714
925
|
export declare class NotFoundException extends __BaseException {
|
|
@@ -737,12 +948,14 @@ export type MergeType = (typeof MergeType)[keyof typeof MergeType];
|
|
|
737
948
|
*/
|
|
738
949
|
export interface SourceApiAssociationConfig {
|
|
739
950
|
/**
|
|
740
|
-
* <p>The property that indicates which merging option is enabled in the source API
|
|
741
|
-
*
|
|
742
|
-
*
|
|
743
|
-
*
|
|
744
|
-
* source APIs
|
|
745
|
-
*
|
|
951
|
+
* <p>The property that indicates which merging option is enabled in the source API
|
|
952
|
+
* association.</p>
|
|
953
|
+
* <p>Valid merge types are <code>MANUAL_MERGE</code> (default) and <code>AUTO_MERGE</code>.
|
|
954
|
+
* Manual merges are the default behavior and require the user to trigger any changes from the
|
|
955
|
+
* source APIs to the merged API manually. Auto merges subscribe the merged API to the changes
|
|
956
|
+
* performed on the source APIs so that any change in the source APIs are also made to the
|
|
957
|
+
* merged API. Auto merges use <code>MergedApiExecutionRoleArn</code> to perform merge
|
|
958
|
+
* operations.</p>
|
|
746
959
|
* @public
|
|
747
960
|
*/
|
|
748
961
|
mergeType?: MergeType;
|
|
@@ -752,16 +965,18 @@ export interface SourceApiAssociationConfig {
|
|
|
752
965
|
*/
|
|
753
966
|
export interface AssociateMergedGraphqlApiRequest {
|
|
754
967
|
/**
|
|
755
|
-
* <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In
|
|
756
|
-
* APIs (especially in your account) only require the API ID value or ARN
|
|
757
|
-
* from other accounts (cross-account use cases)
|
|
968
|
+
* <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In
|
|
969
|
+
* most cases, source APIs (especially in your account) only require the API ID value or ARN
|
|
970
|
+
* of the source API. However, source APIs from other accounts (cross-account use cases)
|
|
971
|
+
* strictly require the full resource ARN of the source API.</p>
|
|
758
972
|
* @public
|
|
759
973
|
*/
|
|
760
974
|
sourceApiIdentifier: string | undefined;
|
|
761
975
|
/**
|
|
762
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
763
|
-
* APIs (especially in your account) only require the API ID value or ARN
|
|
764
|
-
* in other accounts (cross-account use cases)
|
|
976
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
977
|
+
* most cases, Merged APIs (especially in your account) only require the API ID value or ARN
|
|
978
|
+
* of the merged API. However, Merged APIs in other accounts (cross-account use cases)
|
|
979
|
+
* strictly require the full resource ARN of the merged API.</p>
|
|
765
980
|
* @public
|
|
766
981
|
*/
|
|
767
982
|
mergedApiIdentifier: string | undefined;
|
|
@@ -795,13 +1010,12 @@ export declare const SourceApiAssociationStatus: {
|
|
|
795
1010
|
*/
|
|
796
1011
|
export type SourceApiAssociationStatus = (typeof SourceApiAssociationStatus)[keyof typeof SourceApiAssociationStatus];
|
|
797
1012
|
/**
|
|
798
|
-
* <p>Describes the configuration of a source API. A source API is a GraphQL API that is
|
|
799
|
-
* There can be multiple source APIs attached to each merged API. When
|
|
800
|
-
*
|
|
801
|
-
* API. </p>
|
|
802
|
-
* <p>Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access
|
|
803
|
-
*
|
|
804
|
-
* Access Manager?</a> in the <i>Amazon Web Services Resource Access Manager</i> guide.</p>
|
|
1013
|
+
* <p>Describes the configuration of a source API. A source API is a GraphQL API that is
|
|
1014
|
+
* linked to a merged API. There can be multiple source APIs attached to each merged API. When
|
|
1015
|
+
* linked to a merged API, the source API's schema, data sources, and resolvers will be
|
|
1016
|
+
* combined with other linked source API data to form a new, singular API. </p>
|
|
1017
|
+
* <p>Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access Manager. For more information about sharing resources from other
|
|
1018
|
+
* accounts, see <a href="https://docs.aws.amazon.com/ram/latest/userguide/what-is.html">What is Amazon Web Services Resource Access Manager?</a> in the <i>Amazon Web Services Resource Access Manager</i> guide.</p>
|
|
805
1019
|
* @public
|
|
806
1020
|
*/
|
|
807
1021
|
export interface SourceApiAssociation {
|
|
@@ -856,8 +1070,8 @@ export interface SourceApiAssociation {
|
|
|
856
1070
|
*/
|
|
857
1071
|
sourceApiAssociationStatusDetail?: string;
|
|
858
1072
|
/**
|
|
859
|
-
* <p>The datetime value of the last successful merge of the source API association. The
|
|
860
|
-
* format and your local time zone.</p>
|
|
1073
|
+
* <p>The datetime value of the last successful merge of the source API association. The
|
|
1074
|
+
* result will be in UTC format and your local time zone.</p>
|
|
861
1075
|
* @public
|
|
862
1076
|
*/
|
|
863
1077
|
lastSuccessfulMergeDate?: Date;
|
|
@@ -873,8 +1087,8 @@ export interface AssociateMergedGraphqlApiResponse {
|
|
|
873
1087
|
sourceApiAssociation?: SourceApiAssociation;
|
|
874
1088
|
}
|
|
875
1089
|
/**
|
|
876
|
-
* <p>Another modification is in progress at this time and it must complete before you can
|
|
877
|
-
* change.</p>
|
|
1090
|
+
* <p>Another modification is in progress at this time and it must complete before you can
|
|
1091
|
+
* make your change.</p>
|
|
878
1092
|
* @public
|
|
879
1093
|
*/
|
|
880
1094
|
export declare class ConcurrentModificationException extends __BaseException {
|
|
@@ -914,16 +1128,18 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
914
1128
|
*/
|
|
915
1129
|
export interface AssociateSourceGraphqlApiRequest {
|
|
916
1130
|
/**
|
|
917
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
918
|
-
* APIs (especially in your account) only require the API ID value or ARN
|
|
919
|
-
* in other accounts (cross-account use cases)
|
|
1131
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
1132
|
+
* most cases, Merged APIs (especially in your account) only require the API ID value or ARN
|
|
1133
|
+
* of the merged API. However, Merged APIs in other accounts (cross-account use cases)
|
|
1134
|
+
* strictly require the full resource ARN of the merged API.</p>
|
|
920
1135
|
* @public
|
|
921
1136
|
*/
|
|
922
1137
|
mergedApiIdentifier: string | undefined;
|
|
923
1138
|
/**
|
|
924
|
-
* <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In
|
|
925
|
-
* APIs (especially in your account) only require the API ID value or ARN
|
|
926
|
-
* from other accounts (cross-account use cases)
|
|
1139
|
+
* <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In
|
|
1140
|
+
* most cases, source APIs (especially in your account) only require the API ID value or ARN
|
|
1141
|
+
* of the source API. However, source APIs from other accounts (cross-account use cases)
|
|
1142
|
+
* strictly require the full resource ARN of the source API.</p>
|
|
927
1143
|
* @public
|
|
928
1144
|
*/
|
|
929
1145
|
sourceApiIdentifier: string | undefined;
|
|
@@ -985,8 +1201,8 @@ export interface AuthorizationConfig {
|
|
|
985
1201
|
* <ul>
|
|
986
1202
|
* <li>
|
|
987
1203
|
* <p>
|
|
988
|
-
* <b>AWS_IAM</b>: The authorization type is Signature
|
|
989
|
-
* (SigV4).</p>
|
|
1204
|
+
* <b>AWS_IAM</b>: The authorization type is Signature
|
|
1205
|
+
* Version 4 (SigV4).</p>
|
|
990
1206
|
* </li>
|
|
991
1207
|
* </ul>
|
|
992
1208
|
* @public
|
|
@@ -998,6 +1214,55 @@ export interface AuthorizationConfig {
|
|
|
998
1214
|
*/
|
|
999
1215
|
awsIamConfig?: AwsIamConfig;
|
|
1000
1216
|
}
|
|
1217
|
+
/**
|
|
1218
|
+
* @public
|
|
1219
|
+
*/
|
|
1220
|
+
export interface CreateApiRequest {
|
|
1221
|
+
/**
|
|
1222
|
+
* <p>The name for the <code>Api</code>.</p>
|
|
1223
|
+
* @public
|
|
1224
|
+
*/
|
|
1225
|
+
name: string | undefined;
|
|
1226
|
+
/**
|
|
1227
|
+
* <p>The owner contact information for the <code>Api</code>.</p>
|
|
1228
|
+
* @public
|
|
1229
|
+
*/
|
|
1230
|
+
ownerContact?: string;
|
|
1231
|
+
/**
|
|
1232
|
+
* <p>A map with keys of <code>TagKey</code> objects and values of <code>TagValue</code>
|
|
1233
|
+
* objects.</p>
|
|
1234
|
+
* @public
|
|
1235
|
+
*/
|
|
1236
|
+
tags?: Record<string, string>;
|
|
1237
|
+
/**
|
|
1238
|
+
* <p>The Event API configuration. This includes the default authorization configuration for
|
|
1239
|
+
* connecting, publishing, and subscribing to an Event API.</p>
|
|
1240
|
+
* @public
|
|
1241
|
+
*/
|
|
1242
|
+
eventConfig?: EventConfig;
|
|
1243
|
+
}
|
|
1244
|
+
/**
|
|
1245
|
+
* @public
|
|
1246
|
+
*/
|
|
1247
|
+
export interface CreateApiResponse {
|
|
1248
|
+
/**
|
|
1249
|
+
* <p>The <code>Api</code> object.</p>
|
|
1250
|
+
* @public
|
|
1251
|
+
*/
|
|
1252
|
+
api?: Api;
|
|
1253
|
+
}
|
|
1254
|
+
/**
|
|
1255
|
+
* <p>The operation exceeded the service quota for this resource.</p>
|
|
1256
|
+
* @public
|
|
1257
|
+
*/
|
|
1258
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
1259
|
+
readonly name: "ServiceQuotaExceededException";
|
|
1260
|
+
readonly $fault: "client";
|
|
1261
|
+
/**
|
|
1262
|
+
* @internal
|
|
1263
|
+
*/
|
|
1264
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
1265
|
+
}
|
|
1001
1266
|
/**
|
|
1002
1267
|
* <p>Represents the input of a <code>CreateApiCache</code> operation.</p>
|
|
1003
1268
|
* @public
|
|
@@ -1015,7 +1280,8 @@ export interface CreateApiCacheRequest {
|
|
|
1015
1280
|
*/
|
|
1016
1281
|
ttl: number | undefined;
|
|
1017
1282
|
/**
|
|
1018
|
-
* <p>Transit encryption flag when connecting to cache. You cannot update this setting after
|
|
1283
|
+
* <p>Transit encryption flag when connecting to cache. You cannot update this setting after
|
|
1284
|
+
* creation.</p>
|
|
1019
1285
|
* @public
|
|
1020
1286
|
*/
|
|
1021
1287
|
transitEncryptionEnabled?: boolean;
|
|
@@ -1029,12 +1295,13 @@ export interface CreateApiCacheRequest {
|
|
|
1029
1295
|
* <ul>
|
|
1030
1296
|
* <li>
|
|
1031
1297
|
* <p>
|
|
1032
|
-
* <b>FULL_REQUEST_CACHING</b>: All requests are fully
|
|
1298
|
+
* <b>FULL_REQUEST_CACHING</b>: All requests are fully
|
|
1299
|
+
* cached.</p>
|
|
1033
1300
|
* </li>
|
|
1034
1301
|
* <li>
|
|
1035
1302
|
* <p>
|
|
1036
|
-
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers
|
|
1037
|
-
* cached.</p>
|
|
1303
|
+
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers
|
|
1304
|
+
* that you specify are cached.</p>
|
|
1038
1305
|
* </li>
|
|
1039
1306
|
* </ul>
|
|
1040
1307
|
* @public
|
|
@@ -1119,20 +1386,22 @@ export interface CreateApiCacheRequest {
|
|
|
1119
1386
|
*/
|
|
1120
1387
|
type: ApiCacheType | undefined;
|
|
1121
1388
|
/**
|
|
1122
|
-
* <p>Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics
|
|
1389
|
+
* <p>Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics
|
|
1390
|
+
* include:</p>
|
|
1123
1391
|
* <ul>
|
|
1124
1392
|
* <li>
|
|
1125
|
-
* <p>NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the
|
|
1126
|
-
* the aggregated bandwidth limit. This is useful for diagnosing
|
|
1127
|
-
* configuration.</p>
|
|
1393
|
+
* <p>NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the
|
|
1394
|
+
* throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing
|
|
1395
|
+
* bottlenecks in a cache configuration.</p>
|
|
1128
1396
|
* </li>
|
|
1129
1397
|
* <li>
|
|
1130
|
-
* <p>EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis
|
|
1131
|
-
* useful for diagnosing bottlenecks in a cache
|
|
1398
|
+
* <p>EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis
|
|
1399
|
+
* process. This is useful for diagnosing bottlenecks in a cache
|
|
1400
|
+
* configuration.</p>
|
|
1132
1401
|
* </li>
|
|
1133
1402
|
* </ul>
|
|
1134
1403
|
* <p>Metrics will be recorded by API ID. You can set the value to <code>ENABLED</code> or
|
|
1135
|
-
*
|
|
1404
|
+
* <code>DISABLED</code>.</p>
|
|
1136
1405
|
* @public
|
|
1137
1406
|
*/
|
|
1138
1407
|
healthMetricsConfig?: CacheHealthMetricsConfig;
|
|
@@ -1163,9 +1432,9 @@ export interface CreateApiKeyRequest {
|
|
|
1163
1432
|
*/
|
|
1164
1433
|
description?: string;
|
|
1165
1434
|
/**
|
|
1166
|
-
* <p>From the creation time, the time after which the API key expires. The date is
|
|
1167
|
-
* the epoch, rounded down to the nearest hour. The default value
|
|
1168
|
-
* For more information, see .</p>
|
|
1435
|
+
* <p>From the creation time, the time after which the API key expires. The date is
|
|
1436
|
+
* represented as seconds since the epoch, rounded down to the nearest hour. The default value
|
|
1437
|
+
* for this parameter is 7 days from creation time. For more information, see .</p>
|
|
1169
1438
|
* @public
|
|
1170
1439
|
*/
|
|
1171
1440
|
expires?: number;
|
|
@@ -1180,6 +1449,128 @@ export interface CreateApiKeyResponse {
|
|
|
1180
1449
|
*/
|
|
1181
1450
|
apiKey?: ApiKey;
|
|
1182
1451
|
}
|
|
1452
|
+
/**
|
|
1453
|
+
* <p>A conflict with a previous successful update is detected. This typically
|
|
1454
|
+
* occurs when the previous update did not have time to propagate before the next update was
|
|
1455
|
+
* made. A retry (with appropriate backoff logic) is the recommended response to this
|
|
1456
|
+
* exception.</p>
|
|
1457
|
+
* @public
|
|
1458
|
+
*/
|
|
1459
|
+
export declare class ConflictException extends __BaseException {
|
|
1460
|
+
readonly name: "ConflictException";
|
|
1461
|
+
readonly $fault: "client";
|
|
1462
|
+
/**
|
|
1463
|
+
* @internal
|
|
1464
|
+
*/
|
|
1465
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
1466
|
+
}
|
|
1467
|
+
/**
|
|
1468
|
+
* @public
|
|
1469
|
+
*/
|
|
1470
|
+
export interface CreateChannelNamespaceRequest {
|
|
1471
|
+
/**
|
|
1472
|
+
* <p>The <code>Api</code> ID.</p>
|
|
1473
|
+
* @public
|
|
1474
|
+
*/
|
|
1475
|
+
apiId: string | undefined;
|
|
1476
|
+
/**
|
|
1477
|
+
* <p>The name of the <code>ChannelNamespace</code>. This name must be unique within the
|
|
1478
|
+
* <code>Api</code>
|
|
1479
|
+
* </p>
|
|
1480
|
+
* @public
|
|
1481
|
+
*/
|
|
1482
|
+
name: string | undefined;
|
|
1483
|
+
/**
|
|
1484
|
+
* <p>The authorization mode to use for subscribing to messages on the channel namespace. This
|
|
1485
|
+
* configuration overrides the default <code>Api</code> authorization configuration.</p>
|
|
1486
|
+
* @public
|
|
1487
|
+
*/
|
|
1488
|
+
subscribeAuthModes?: AuthMode[];
|
|
1489
|
+
/**
|
|
1490
|
+
* <p>The authorization mode to use for publishing messages on the channel namespace. This
|
|
1491
|
+
* configuration overrides the default <code>Api</code> authorization configuration.</p>
|
|
1492
|
+
* @public
|
|
1493
|
+
*/
|
|
1494
|
+
publishAuthModes?: AuthMode[];
|
|
1495
|
+
/**
|
|
1496
|
+
* <p>The event handler functions that run custom business logic to process published events
|
|
1497
|
+
* and subscribe requests.</p>
|
|
1498
|
+
* @public
|
|
1499
|
+
*/
|
|
1500
|
+
codeHandlers?: string;
|
|
1501
|
+
/**
|
|
1502
|
+
* <p>A map with keys of <code>TagKey</code> objects and values of <code>TagValue</code>
|
|
1503
|
+
* objects.</p>
|
|
1504
|
+
* @public
|
|
1505
|
+
*/
|
|
1506
|
+
tags?: Record<string, string>;
|
|
1507
|
+
}
|
|
1508
|
+
/**
|
|
1509
|
+
* <p>Describes a channel namespace associated with an <code>Api</code>. The <code>ChannelNamespace</code> contains the definitions for code handlers for the <code>Api</code>.</p>
|
|
1510
|
+
* @public
|
|
1511
|
+
*/
|
|
1512
|
+
export interface ChannelNamespace {
|
|
1513
|
+
/**
|
|
1514
|
+
* <p>The <code>Api</code> ID.</p>
|
|
1515
|
+
* @public
|
|
1516
|
+
*/
|
|
1517
|
+
apiId?: string;
|
|
1518
|
+
/**
|
|
1519
|
+
* <p>The name of the channel namespace. This name must be unique within the
|
|
1520
|
+
* <code>Api</code>.</p>
|
|
1521
|
+
* @public
|
|
1522
|
+
*/
|
|
1523
|
+
name?: string;
|
|
1524
|
+
/**
|
|
1525
|
+
* <p>The authorization mode to use for subscribing to messages on the channel namespace. This
|
|
1526
|
+
* configuration overrides the default <code>Api</code>authorization configuration.</p>
|
|
1527
|
+
* @public
|
|
1528
|
+
*/
|
|
1529
|
+
subscribeAuthModes?: AuthMode[];
|
|
1530
|
+
/**
|
|
1531
|
+
* <p>The authorization mode to use for publishing messages on the channel namespace. This
|
|
1532
|
+
* configuration overrides the default <code>Api</code>authorization configuration.</p>
|
|
1533
|
+
* @public
|
|
1534
|
+
*/
|
|
1535
|
+
publishAuthModes?: AuthMode[];
|
|
1536
|
+
/**
|
|
1537
|
+
* <p>The event handler functions that run custom business logic to process published events
|
|
1538
|
+
* and subscribe requests.</p>
|
|
1539
|
+
* @public
|
|
1540
|
+
*/
|
|
1541
|
+
codeHandlers?: string;
|
|
1542
|
+
/**
|
|
1543
|
+
* <p>A map with keys of <code>TagKey</code> objects and values of <code>TagValue</code>
|
|
1544
|
+
* objects.</p>
|
|
1545
|
+
* @public
|
|
1546
|
+
*/
|
|
1547
|
+
tags?: Record<string, string>;
|
|
1548
|
+
/**
|
|
1549
|
+
* <p>The Amazon Resource Name (ARN) for the <code>ChannelNamespace</code>.</p>
|
|
1550
|
+
* @public
|
|
1551
|
+
*/
|
|
1552
|
+
channelNamespaceArn?: string;
|
|
1553
|
+
/**
|
|
1554
|
+
* <p>The date and time that the <code>ChannelNamespace</code> was created.</p>
|
|
1555
|
+
* @public
|
|
1556
|
+
*/
|
|
1557
|
+
created?: Date;
|
|
1558
|
+
/**
|
|
1559
|
+
* <p>The date and time that the <code>ChannelNamespace</code> was last changed.</p>
|
|
1560
|
+
* @public
|
|
1561
|
+
*/
|
|
1562
|
+
lastModified?: Date;
|
|
1563
|
+
}
|
|
1564
|
+
/**
|
|
1565
|
+
* @public
|
|
1566
|
+
*/
|
|
1567
|
+
export interface CreateChannelNamespaceResponse {
|
|
1568
|
+
/**
|
|
1569
|
+
* <p>The <code>ChannelNamespace</code> object.</p>
|
|
1570
|
+
* @public
|
|
1571
|
+
*/
|
|
1572
|
+
channelNamespace?: ChannelNamespace;
|
|
1573
|
+
}
|
|
1183
1574
|
/**
|
|
1184
1575
|
* <p>Describes a Delta Sync configuration.</p>
|
|
1185
1576
|
* @public
|
|
@@ -1196,7 +1587,8 @@ export interface DeltaSyncConfig {
|
|
|
1196
1587
|
*/
|
|
1197
1588
|
deltaSyncTableName?: string;
|
|
1198
1589
|
/**
|
|
1199
|
-
* <p>The number of minutes that a Delta Sync log entry is stored in the Delta Sync
|
|
1590
|
+
* <p>The number of minutes that a Delta Sync log entry is stored in the Delta Sync
|
|
1591
|
+
* table.</p>
|
|
1200
1592
|
* @public
|
|
1201
1593
|
*/
|
|
1202
1594
|
deltaSyncTableTTL?: number;
|
|
@@ -1234,8 +1626,9 @@ export interface DynamodbDataSourceConfig {
|
|
|
1234
1626
|
}
|
|
1235
1627
|
/**
|
|
1236
1628
|
* <p>Describes an OpenSearch data source configuration.</p>
|
|
1237
|
-
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This
|
|
1238
|
-
* deprecated. For new data sources, use <a>OpenSearchServiceDataSourceConfig</a> to specify an OpenSearch data
|
|
1629
|
+
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This
|
|
1630
|
+
* configuration is deprecated. For new data sources, use <a>OpenSearchServiceDataSourceConfig</a> to specify an OpenSearch data
|
|
1631
|
+
* source.</p>
|
|
1239
1632
|
* @public
|
|
1240
1633
|
*/
|
|
1241
1634
|
export interface ElasticsearchDataSourceConfig {
|
|
@@ -1256,8 +1649,8 @@ export interface ElasticsearchDataSourceConfig {
|
|
|
1256
1649
|
*/
|
|
1257
1650
|
export interface EventBridgeDataSourceConfig {
|
|
1258
1651
|
/**
|
|
1259
|
-
* <p>The ARN of the event bus. For more information about event buses, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html">Amazon
|
|
1260
|
-
* buses</a>.</p>
|
|
1652
|
+
* <p>The ARN of the event bus. For more information about event buses, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html">Amazon
|
|
1653
|
+
* EventBridge event buses</a>.</p>
|
|
1261
1654
|
* @public
|
|
1262
1655
|
*/
|
|
1263
1656
|
eventBusArn: string | undefined;
|
|
@@ -1268,9 +1661,10 @@ export interface EventBridgeDataSourceConfig {
|
|
|
1268
1661
|
*/
|
|
1269
1662
|
export interface HttpDataSourceConfig {
|
|
1270
1663
|
/**
|
|
1271
|
-
* <p>The HTTP URL endpoint. You can specify either the domain name or IP, and port
|
|
1272
|
-
* scheme must be HTTP or HTTPS. If you don't specify the port,
|
|
1273
|
-
*
|
|
1664
|
+
* <p>The HTTP URL endpoint. You can specify either the domain name or IP, and port
|
|
1665
|
+
* combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port,
|
|
1666
|
+
* AppSync uses the default port 80 for the HTTP endpoint and port 443 for
|
|
1667
|
+
* HTTPS endpoints.</p>
|
|
1274
1668
|
* @public
|
|
1275
1669
|
*/
|
|
1276
1670
|
endpoint?: string;
|
|
@@ -1345,7 +1739,8 @@ export interface RdsHttpEndpointConfig {
|
|
|
1345
1739
|
*/
|
|
1346
1740
|
schema?: string;
|
|
1347
1741
|
/**
|
|
1348
|
-
* <p>Amazon Web Services secret store Amazon Resource Name (ARN) for database
|
|
1742
|
+
* <p>Amazon Web Services secret store Amazon Resource Name (ARN) for database
|
|
1743
|
+
* credentials.</p>
|
|
1349
1744
|
* @public
|
|
1350
1745
|
*/
|
|
1351
1746
|
awsSecretStoreArn?: string;
|
|
@@ -1371,8 +1766,9 @@ export interface RelationalDatabaseDataSourceConfig {
|
|
|
1371
1766
|
* <ul>
|
|
1372
1767
|
* <li>
|
|
1373
1768
|
* <p>
|
|
1374
|
-
* <b>RDS_HTTP_ENDPOINT</b>: The relational database
|
|
1375
|
-
*
|
|
1769
|
+
* <b>RDS_HTTP_ENDPOINT</b>: The relational database
|
|
1770
|
+
* source type is an Amazon Relational Database Service (Amazon RDS) HTTP
|
|
1771
|
+
* endpoint.</p>
|
|
1376
1772
|
* </li>
|
|
1377
1773
|
* </ul>
|
|
1378
1774
|
* @public
|
|
@@ -1427,8 +1823,8 @@ export interface CreateDataSourceRequest {
|
|
|
1427
1823
|
*/
|
|
1428
1824
|
type: DataSourceType | undefined;
|
|
1429
1825
|
/**
|
|
1430
|
-
* <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)
|
|
1431
|
-
* The system assumes this role when accessing the data source.</p>
|
|
1826
|
+
* <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)
|
|
1827
|
+
* for the data source. The system assumes this role when accessing the data source.</p>
|
|
1432
1828
|
* @public
|
|
1433
1829
|
*/
|
|
1434
1830
|
serviceRoleArn?: string;
|
|
@@ -1444,9 +1840,8 @@ export interface CreateDataSourceRequest {
|
|
|
1444
1840
|
lambdaConfig?: LambdaDataSourceConfig;
|
|
1445
1841
|
/**
|
|
1446
1842
|
* <p>Amazon OpenSearch Service settings.</p>
|
|
1447
|
-
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This
|
|
1448
|
-
* deprecated. For new data sources, use <a>CreateDataSourceRequest$openSearchServiceConfig</a> to
|
|
1449
|
-
* create an OpenSearch data source.</p>
|
|
1843
|
+
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This
|
|
1844
|
+
* configuration is deprecated. For new data sources, use <a>CreateDataSourceRequest$openSearchServiceConfig</a> to create an OpenSearch data source.</p>
|
|
1450
1845
|
* @public
|
|
1451
1846
|
*/
|
|
1452
1847
|
elasticsearchConfig?: ElasticsearchDataSourceConfig;
|
|
@@ -1472,10 +1867,11 @@ export interface CreateDataSourceRequest {
|
|
|
1472
1867
|
eventBridgeConfig?: EventBridgeDataSourceConfig;
|
|
1473
1868
|
/**
|
|
1474
1869
|
* <p>Enables or disables enhanced data source metrics for specified data sources. Note that
|
|
1475
|
-
* <code>metricsConfig</code> won't be used unless the
|
|
1476
|
-
*
|
|
1477
|
-
* <code>
|
|
1478
|
-
*
|
|
1870
|
+
* <code>metricsConfig</code> won't be used unless the
|
|
1871
|
+
* <code>dataSourceLevelMetricsBehavior</code> value is set to
|
|
1872
|
+
* <code>PER_DATA_SOURCE_METRICS</code>. If the <code>dataSourceLevelMetricsBehavior</code>
|
|
1873
|
+
* is set to <code>FULL_REQUEST_DATA_SOURCE_METRICS</code> instead, <code>metricsConfig</code>
|
|
1874
|
+
* will be ignored. However, you can still set its value.</p>
|
|
1479
1875
|
* <p>
|
|
1480
1876
|
* <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
1481
1877
|
* @public
|
|
@@ -1507,50 +1903,51 @@ export interface DataSource {
|
|
|
1507
1903
|
* <ul>
|
|
1508
1904
|
* <li>
|
|
1509
1905
|
* <p>
|
|
1510
|
-
* <b>AWS_LAMBDA</b>: The data source is an Lambda
|
|
1511
|
-
* function.</p>
|
|
1906
|
+
* <b>AWS_LAMBDA</b>: The data source is an Lambda function.</p>
|
|
1512
1907
|
* </li>
|
|
1513
1908
|
* <li>
|
|
1514
1909
|
* <p>
|
|
1515
|
-
* <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB
|
|
1516
|
-
* table.</p>
|
|
1910
|
+
* <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p>
|
|
1517
1911
|
* </li>
|
|
1518
1912
|
* <li>
|
|
1519
1913
|
* <p>
|
|
1520
|
-
* <b>AMAZON_ELASTICSEARCH</b>: The data source is an
|
|
1521
|
-
*
|
|
1914
|
+
* <b>AMAZON_ELASTICSEARCH</b>: The data source is an
|
|
1915
|
+
* Amazon OpenSearch Service domain.</p>
|
|
1522
1916
|
* </li>
|
|
1523
1917
|
* <li>
|
|
1524
1918
|
* <p>
|
|
1525
|
-
* <b>AMAZON_OPENSEARCH_SERVICE</b>: The data source is
|
|
1919
|
+
* <b>AMAZON_OPENSEARCH_SERVICE</b>: The data source is
|
|
1920
|
+
* an Amazon OpenSearch Service domain.</p>
|
|
1526
1921
|
* </li>
|
|
1527
1922
|
* <li>
|
|
1528
1923
|
* <p>
|
|
1529
|
-
* <b>AMAZON_EVENTBRIDGE</b>: The data source is an
|
|
1530
|
-
*
|
|
1924
|
+
* <b>AMAZON_EVENTBRIDGE</b>: The data source is an
|
|
1925
|
+
* Amazon EventBridge configuration.</p>
|
|
1531
1926
|
* </li>
|
|
1532
1927
|
* <li>
|
|
1533
1928
|
* <p>
|
|
1534
|
-
* <b>NONE</b>: There is no data source. Use this type
|
|
1535
|
-
* invoke a GraphQL operation without connecting to a data source, such
|
|
1536
|
-
* transformation with resolvers or invoking a
|
|
1929
|
+
* <b>NONE</b>: There is no data source. Use this type
|
|
1930
|
+
* when you want to invoke a GraphQL operation without connecting to a data source, such
|
|
1931
|
+
* as when you're performing data transformation with resolvers or invoking a
|
|
1932
|
+
* subscription from a mutation.</p>
|
|
1537
1933
|
* </li>
|
|
1538
1934
|
* <li>
|
|
1539
1935
|
* <p>
|
|
1540
|
-
* <b>HTTP</b>: The data source is an HTTP
|
|
1936
|
+
* <b>HTTP</b>: The data source is an HTTP
|
|
1937
|
+
* endpoint.</p>
|
|
1541
1938
|
* </li>
|
|
1542
1939
|
* <li>
|
|
1543
1940
|
* <p>
|
|
1544
|
-
* <b>RELATIONAL_DATABASE</b>: The data source is a
|
|
1545
|
-
* database.</p>
|
|
1941
|
+
* <b>RELATIONAL_DATABASE</b>: The data source is a
|
|
1942
|
+
* relational database.</p>
|
|
1546
1943
|
* </li>
|
|
1547
1944
|
* </ul>
|
|
1548
1945
|
* @public
|
|
1549
1946
|
*/
|
|
1550
1947
|
type?: DataSourceType;
|
|
1551
1948
|
/**
|
|
1552
|
-
* <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)
|
|
1553
|
-
* The system assumes this role when accessing the data source.</p>
|
|
1949
|
+
* <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)
|
|
1950
|
+
* for the data source. The system assumes this role when accessing the data source.</p>
|
|
1554
1951
|
* @public
|
|
1555
1952
|
*/
|
|
1556
1953
|
serviceRoleArn?: string;
|
|
@@ -1591,10 +1988,11 @@ export interface DataSource {
|
|
|
1591
1988
|
eventBridgeConfig?: EventBridgeDataSourceConfig;
|
|
1592
1989
|
/**
|
|
1593
1990
|
* <p>Enables or disables enhanced data source metrics for specified data sources. Note that
|
|
1594
|
-
* <code>metricsConfig</code> won't be used unless the
|
|
1595
|
-
*
|
|
1596
|
-
* <code>
|
|
1597
|
-
*
|
|
1991
|
+
* <code>metricsConfig</code> won't be used unless the
|
|
1992
|
+
* <code>dataSourceLevelMetricsBehavior</code> value is set to
|
|
1993
|
+
* <code>PER_DATA_SOURCE_METRICS</code>. If the <code>dataSourceLevelMetricsBehavior</code>
|
|
1994
|
+
* is set to <code>FULL_REQUEST_DATA_SOURCE_METRICS</code> instead, <code>metricsConfig</code>
|
|
1995
|
+
* will be ignored. However, you can still set its value.</p>
|
|
1598
1996
|
* <p>
|
|
1599
1997
|
* <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
1600
1998
|
* @public
|
|
@@ -1621,7 +2019,9 @@ export interface CreateDomainNameRequest {
|
|
|
1621
2019
|
*/
|
|
1622
2020
|
domainName: string | undefined;
|
|
1623
2021
|
/**
|
|
1624
|
-
* <p>The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager
|
|
2022
|
+
* <p>The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager
|
|
2023
|
+
* (ACM) certificate or an Identity and Access Management (IAM)
|
|
2024
|
+
* server certificate.</p>
|
|
1625
2025
|
* @public
|
|
1626
2026
|
*/
|
|
1627
2027
|
certificateArn: string | undefined;
|
|
@@ -1647,7 +2047,9 @@ export interface DomainNameConfig {
|
|
|
1647
2047
|
*/
|
|
1648
2048
|
description?: string;
|
|
1649
2049
|
/**
|
|
1650
|
-
* <p>The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager
|
|
2050
|
+
* <p>The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager
|
|
2051
|
+
* (ACM) certificate or an Identity and Access Management (IAM)
|
|
2052
|
+
* server certificate.</p>
|
|
1651
2053
|
* @public
|
|
1652
2054
|
*/
|
|
1653
2055
|
certificateArn?: string;
|
|
@@ -1699,21 +2101,22 @@ export declare const ConflictHandlerType: {
|
|
|
1699
2101
|
*/
|
|
1700
2102
|
export type ConflictHandlerType = (typeof ConflictHandlerType)[keyof typeof ConflictHandlerType];
|
|
1701
2103
|
/**
|
|
1702
|
-
* <p>The <code>LambdaConflictHandlerConfig</code> object when configuring <code>LAMBDA</code>
|
|
1703
|
-
* Handler.</p>
|
|
2104
|
+
* <p>The <code>LambdaConflictHandlerConfig</code> object when configuring <code>LAMBDA</code>
|
|
2105
|
+
* as the Conflict Handler.</p>
|
|
1704
2106
|
* @public
|
|
1705
2107
|
*/
|
|
1706
2108
|
export interface LambdaConflictHandlerConfig {
|
|
1707
2109
|
/**
|
|
1708
|
-
* <p>The Amazon Resource Name (ARN) for the Lambda function to use as the
|
|
2110
|
+
* <p>The Amazon Resource Name (ARN) for the Lambda function to use as the
|
|
2111
|
+
* Conflict Handler.</p>
|
|
1709
2112
|
* @public
|
|
1710
2113
|
*/
|
|
1711
2114
|
lambdaConflictHandlerArn?: string;
|
|
1712
2115
|
}
|
|
1713
2116
|
/**
|
|
1714
2117
|
* <p>Describes a Sync configuration for a resolver.</p>
|
|
1715
|
-
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
1716
|
-
* invoked.</p>
|
|
2118
|
+
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
2119
|
+
* resolver is invoked.</p>
|
|
1717
2120
|
* @public
|
|
1718
2121
|
*/
|
|
1719
2122
|
export interface SyncConfig {
|
|
@@ -1722,18 +2125,19 @@ export interface SyncConfig {
|
|
|
1722
2125
|
* <ul>
|
|
1723
2126
|
* <li>
|
|
1724
2127
|
* <p>
|
|
1725
|
-
* <b>OPTIMISTIC_CONCURRENCY</b>: Resolve conflicts by
|
|
1726
|
-
* when versions don't match the latest version at the
|
|
2128
|
+
* <b>OPTIMISTIC_CONCURRENCY</b>: Resolve conflicts by
|
|
2129
|
+
* rejecting mutations when versions don't match the latest version at the
|
|
2130
|
+
* server.</p>
|
|
1727
2131
|
* </li>
|
|
1728
2132
|
* <li>
|
|
1729
2133
|
* <p>
|
|
1730
|
-
* <b>AUTOMERGE</b>: Resolve conflicts with the
|
|
1731
|
-
* resolution strategy.</p>
|
|
2134
|
+
* <b>AUTOMERGE</b>: Resolve conflicts with the
|
|
2135
|
+
* Automerge conflict resolution strategy.</p>
|
|
1732
2136
|
* </li>
|
|
1733
2137
|
* <li>
|
|
1734
2138
|
* <p>
|
|
1735
|
-
* <b>LAMBDA</b>: Resolve conflicts with an Lambda function
|
|
1736
|
-
*
|
|
2139
|
+
* <b>LAMBDA</b>: Resolve conflicts with an Lambda function supplied in the
|
|
2140
|
+
* <code>LambdaConflictHandlerConfig</code>.</p>
|
|
1737
2141
|
* </li>
|
|
1738
2142
|
* </ul>
|
|
1739
2143
|
* @public
|
|
@@ -1744,21 +2148,21 @@ export interface SyncConfig {
|
|
|
1744
2148
|
* <ul>
|
|
1745
2149
|
* <li>
|
|
1746
2150
|
* <p>
|
|
1747
|
-
* <b>VERSION</b>: Detect conflicts based on object
|
|
1748
|
-
* resolver.</p>
|
|
2151
|
+
* <b>VERSION</b>: Detect conflicts based on object
|
|
2152
|
+
* versions for this resolver.</p>
|
|
1749
2153
|
* </li>
|
|
1750
2154
|
* <li>
|
|
1751
2155
|
* <p>
|
|
1752
|
-
* <b>NONE</b>: Do not detect conflicts when invoking
|
|
1753
|
-
* resolver.</p>
|
|
2156
|
+
* <b>NONE</b>: Do not detect conflicts when invoking
|
|
2157
|
+
* this resolver.</p>
|
|
1754
2158
|
* </li>
|
|
1755
2159
|
* </ul>
|
|
1756
2160
|
* @public
|
|
1757
2161
|
*/
|
|
1758
2162
|
conflictDetection?: ConflictDetectionType;
|
|
1759
2163
|
/**
|
|
1760
|
-
* <p>The <code>LambdaConflictHandlerConfig</code> when configuring <code>LAMBDA</code> as the
|
|
1761
|
-
* Handler.</p>
|
|
2164
|
+
* <p>The <code>LambdaConflictHandlerConfig</code> when configuring <code>LAMBDA</code> as the
|
|
2165
|
+
* Conflict Handler.</p>
|
|
1762
2166
|
* @public
|
|
1763
2167
|
*/
|
|
1764
2168
|
lambdaConflictHandlerConfig?: LambdaConflictHandlerConfig;
|
|
@@ -1789,8 +2193,8 @@ export interface CreateFunctionRequest {
|
|
|
1789
2193
|
*/
|
|
1790
2194
|
dataSourceName: string | undefined;
|
|
1791
2195
|
/**
|
|
1792
|
-
* <p>The <code>Function</code> request mapping template. Functions support only the
|
|
1793
|
-
* request mapping template.</p>
|
|
2196
|
+
* <p>The <code>Function</code> request mapping template. Functions support only the
|
|
2197
|
+
* 2018-05-29 version of the request mapping template.</p>
|
|
1794
2198
|
* @public
|
|
1795
2199
|
*/
|
|
1796
2200
|
requestMappingTemplate?: string;
|
|
@@ -1800,15 +2204,16 @@ export interface CreateFunctionRequest {
|
|
|
1800
2204
|
*/
|
|
1801
2205
|
responseMappingTemplate?: string;
|
|
1802
2206
|
/**
|
|
1803
|
-
* <p>The <code>version</code> of the request mapping template. Currently, the supported value
|
|
1804
|
-
* that when using VTL and mapping templates, the
|
|
2207
|
+
* <p>The <code>version</code> of the request mapping template. Currently, the supported value
|
|
2208
|
+
* is 2018-05-29. Note that when using VTL and mapping templates, the
|
|
2209
|
+
* <code>functionVersion</code> is required.</p>
|
|
1805
2210
|
* @public
|
|
1806
2211
|
*/
|
|
1807
2212
|
functionVersion?: string;
|
|
1808
2213
|
/**
|
|
1809
2214
|
* <p>Describes a Sync configuration for a resolver.</p>
|
|
1810
|
-
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
1811
|
-
* invoked.</p>
|
|
2215
|
+
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
2216
|
+
* resolver is invoked.</p>
|
|
1812
2217
|
* @public
|
|
1813
2218
|
*/
|
|
1814
2219
|
syncConfig?: SyncConfig;
|
|
@@ -1818,21 +2223,22 @@ export interface CreateFunctionRequest {
|
|
|
1818
2223
|
*/
|
|
1819
2224
|
maxBatchSize?: number;
|
|
1820
2225
|
/**
|
|
1821
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
1822
|
-
*
|
|
1823
|
-
* also be specified.</p>
|
|
2226
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
|
|
2227
|
+
* that if a runtime is specified, code must also be specified.</p>
|
|
1824
2228
|
* @public
|
|
1825
2229
|
*/
|
|
1826
2230
|
runtime?: AppSyncRuntime;
|
|
1827
2231
|
/**
|
|
1828
|
-
* <p>The <code>function</code> code that contains the request and response functions. When
|
|
1829
|
-
*
|
|
2232
|
+
* <p>The <code>function</code> code that contains the request and response functions. When
|
|
2233
|
+
* code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
|
|
2234
|
+
* <code>APPSYNC_JS</code>.</p>
|
|
1830
2235
|
* @public
|
|
1831
2236
|
*/
|
|
1832
2237
|
code?: string;
|
|
1833
2238
|
}
|
|
1834
2239
|
/**
|
|
1835
|
-
* <p>A function is a reusable entity. You can use multiple functions to compose the resolver
|
|
2240
|
+
* <p>A function is a reusable entity. You can use multiple functions to compose the resolver
|
|
2241
|
+
* logic.</p>
|
|
1836
2242
|
* @public
|
|
1837
2243
|
*/
|
|
1838
2244
|
export interface FunctionConfiguration {
|
|
@@ -1862,8 +2268,8 @@ export interface FunctionConfiguration {
|
|
|
1862
2268
|
*/
|
|
1863
2269
|
dataSourceName?: string;
|
|
1864
2270
|
/**
|
|
1865
|
-
* <p>The <code>Function</code> request mapping template. Functions support only the
|
|
1866
|
-
* request mapping template.</p>
|
|
2271
|
+
* <p>The <code>Function</code> request mapping template. Functions support only the
|
|
2272
|
+
* 2018-05-29 version of the request mapping template.</p>
|
|
1867
2273
|
* @public
|
|
1868
2274
|
*/
|
|
1869
2275
|
requestMappingTemplate?: string;
|
|
@@ -1873,15 +2279,15 @@ export interface FunctionConfiguration {
|
|
|
1873
2279
|
*/
|
|
1874
2280
|
responseMappingTemplate?: string;
|
|
1875
2281
|
/**
|
|
1876
|
-
* <p>The version of the request mapping template. Currently, only the 2018-05-29 version of
|
|
1877
|
-
* supported.</p>
|
|
2282
|
+
* <p>The version of the request mapping template. Currently, only the 2018-05-29 version of
|
|
2283
|
+
* the template is supported.</p>
|
|
1878
2284
|
* @public
|
|
1879
2285
|
*/
|
|
1880
2286
|
functionVersion?: string;
|
|
1881
2287
|
/**
|
|
1882
2288
|
* <p>Describes a Sync configuration for a resolver.</p>
|
|
1883
|
-
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
1884
|
-
* invoked.</p>
|
|
2289
|
+
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
2290
|
+
* resolver is invoked.</p>
|
|
1885
2291
|
* @public
|
|
1886
2292
|
*/
|
|
1887
2293
|
syncConfig?: SyncConfig;
|
|
@@ -1891,15 +2297,15 @@ export interface FunctionConfiguration {
|
|
|
1891
2297
|
*/
|
|
1892
2298
|
maxBatchSize?: number;
|
|
1893
2299
|
/**
|
|
1894
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
1895
|
-
*
|
|
1896
|
-
* also be specified.</p>
|
|
2300
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
|
|
2301
|
+
* that if a runtime is specified, code must also be specified.</p>
|
|
1897
2302
|
* @public
|
|
1898
2303
|
*/
|
|
1899
2304
|
runtime?: AppSyncRuntime;
|
|
1900
2305
|
/**
|
|
1901
|
-
* <p>The <code>function</code> code that contains the request and response functions. When
|
|
1902
|
-
*
|
|
2306
|
+
* <p>The <code>function</code> code that contains the request and response functions. When
|
|
2307
|
+
* code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
|
|
2308
|
+
* <code>APPSYNC_JS</code>.</p>
|
|
1903
2309
|
* @public
|
|
1904
2310
|
*/
|
|
1905
2311
|
code?: string;
|
|
@@ -1963,23 +2369,25 @@ export declare const ResolverLevelMetricsBehavior: {
|
|
|
1963
2369
|
*/
|
|
1964
2370
|
export type ResolverLevelMetricsBehavior = (typeof ResolverLevelMetricsBehavior)[keyof typeof ResolverLevelMetricsBehavior];
|
|
1965
2371
|
/**
|
|
1966
|
-
* <p>Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data
|
|
1967
|
-
* performance such as AppSync request and error counts, latency, and cache
|
|
1968
|
-
* is sent to your CloudWatch account, and you can
|
|
2372
|
+
* <p>Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data
|
|
2373
|
+
* on API usage and performance such as AppSync request and error counts, latency, and cache
|
|
2374
|
+
* hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can
|
|
2375
|
+
* configure the types of data that will be sent. </p>
|
|
1969
2376
|
* <p>Enhanced metrics can be configured at the resolver, data source, and operation levels.
|
|
1970
|
-
* <code>EnhancedMetricsConfig</code> contains three required parameters, each controlling
|
|
1971
|
-
* categories:</p>
|
|
2377
|
+
* <code>EnhancedMetricsConfig</code> contains three required parameters, each controlling
|
|
2378
|
+
* one of these categories:</p>
|
|
1972
2379
|
* <ol>
|
|
1973
2380
|
* <li>
|
|
1974
2381
|
* <p>
|
|
1975
|
-
* <code>resolverLevelMetricsBehavior</code>: Controls how resolver metrics will
|
|
1976
|
-
* CloudWatch. Resolver metrics include:</p>
|
|
2382
|
+
* <code>resolverLevelMetricsBehavior</code>: Controls how resolver metrics will
|
|
2383
|
+
* be emitted to CloudWatch. Resolver metrics include:</p>
|
|
1977
2384
|
* <ul>
|
|
1978
2385
|
* <li>
|
|
1979
2386
|
* <p>GraphQL errors: The number of GraphQL errors that occurred.</p>
|
|
1980
2387
|
* </li>
|
|
1981
2388
|
* <li>
|
|
1982
|
-
* <p>Requests: The number of invocations that occurred during a request.
|
|
2389
|
+
* <p>Requests: The number of invocations that occurred during a request.
|
|
2390
|
+
* </p>
|
|
1983
2391
|
* </li>
|
|
1984
2392
|
* <li>
|
|
1985
2393
|
* <p>Latency: The time to complete a resolver invocation.</p>
|
|
@@ -1991,75 +2399,83 @@ export type ResolverLevelMetricsBehavior = (typeof ResolverLevelMetricsBehavior)
|
|
|
1991
2399
|
* <p>Cache misses: The number of cache misses during a request.</p>
|
|
1992
2400
|
* </li>
|
|
1993
2401
|
* </ul>
|
|
1994
|
-
* <p>These metrics can be emitted to CloudWatch per resolver or for all resolvers in
|
|
1995
|
-
* will be recorded by API ID and resolver name.
|
|
1996
|
-
*
|
|
2402
|
+
* <p>These metrics can be emitted to CloudWatch per resolver or for all resolvers in
|
|
2403
|
+
* the request. Metrics will be recorded by API ID and resolver name.
|
|
2404
|
+
* <code>resolverLevelMetricsBehavior</code> accepts one of these values at a
|
|
2405
|
+
* time:</p>
|
|
1997
2406
|
* <ul>
|
|
1998
2407
|
* <li>
|
|
1999
2408
|
* <p>
|
|
2000
|
-
* <code>FULL_REQUEST_RESOLVER_METRICS</code>: Records and emits metric data
|
|
2001
|
-
* in the request.</p>
|
|
2409
|
+
* <code>FULL_REQUEST_RESOLVER_METRICS</code>: Records and emits metric data
|
|
2410
|
+
* for all resolvers in the request.</p>
|
|
2002
2411
|
* </li>
|
|
2003
2412
|
* <li>
|
|
2004
2413
|
* <p>
|
|
2005
|
-
* <code>PER_RESOLVER_METRICS</code>: Records and emits metric data for
|
|
2006
|
-
*
|
|
2414
|
+
* <code>PER_RESOLVER_METRICS</code>: Records and emits metric data for
|
|
2415
|
+
* resolvers that have the <code>metricsConfig</code> value set to
|
|
2416
|
+
* <code>ENABLED</code>.</p>
|
|
2007
2417
|
* </li>
|
|
2008
2418
|
* </ul>
|
|
2009
2419
|
* </li>
|
|
2010
2420
|
* <li>
|
|
2011
2421
|
* <p>
|
|
2012
|
-
* <code>dataSourceLevelMetricsBehavior</code>: Controls how data source metrics
|
|
2013
|
-
* CloudWatch. Data source metrics include:</p>
|
|
2422
|
+
* <code>dataSourceLevelMetricsBehavior</code>: Controls how data source metrics
|
|
2423
|
+
* will be emitted to CloudWatch. Data source metrics include:</p>
|
|
2014
2424
|
* <ul>
|
|
2015
2425
|
* <li>
|
|
2016
|
-
* <p>Requests: The number of invocations that occured during a
|
|
2426
|
+
* <p>Requests: The number of invocations that occured during a
|
|
2427
|
+
* request.</p>
|
|
2017
2428
|
* </li>
|
|
2018
2429
|
* <li>
|
|
2019
2430
|
* <p>Latency: The time to complete a data source invocation.</p>
|
|
2020
2431
|
* </li>
|
|
2021
2432
|
* <li>
|
|
2022
|
-
* <p>Errors:
|
|
2433
|
+
* <p>Errors: The number of errors that occurred during a data source
|
|
2434
|
+
* invocation.</p>
|
|
2023
2435
|
* </li>
|
|
2024
2436
|
* </ul>
|
|
2025
|
-
* <p>These metrics can be emitted to CloudWatch per data source or for all data sources
|
|
2026
|
-
* Metrics will be recorded by API ID and data source name.
|
|
2027
|
-
*
|
|
2437
|
+
* <p>These metrics can be emitted to CloudWatch per data source or for all data sources
|
|
2438
|
+
* in the request. Metrics will be recorded by API ID and data source name.
|
|
2439
|
+
* <code>dataSourceLevelMetricsBehavior</code> accepts one of these values at a
|
|
2440
|
+
* time:</p>
|
|
2028
2441
|
* <ul>
|
|
2029
2442
|
* <li>
|
|
2030
2443
|
* <p>
|
|
2031
|
-
* <code>FULL_REQUEST_DATA_SOURCE_METRICS</code>: Records and emits metric
|
|
2032
|
-
* sources in the request.</p>
|
|
2444
|
+
* <code>FULL_REQUEST_DATA_SOURCE_METRICS</code>: Records and emits metric
|
|
2445
|
+
* data for all data sources in the request.</p>
|
|
2033
2446
|
* </li>
|
|
2034
2447
|
* <li>
|
|
2035
2448
|
* <p>
|
|
2036
|
-
* <code>PER_DATA_SOURCE_METRICS</code>: Records and emits metric data for
|
|
2037
|
-
* have the <code>metricsConfig</code> value set to
|
|
2449
|
+
* <code>PER_DATA_SOURCE_METRICS</code>: Records and emits metric data for
|
|
2450
|
+
* data sources that have the <code>metricsConfig</code> value set to
|
|
2451
|
+
* <code>ENABLED</code>.</p>
|
|
2038
2452
|
* </li>
|
|
2039
2453
|
* </ul>
|
|
2040
2454
|
* </li>
|
|
2041
2455
|
* <li>
|
|
2042
2456
|
* <p>
|
|
2043
|
-
* <code>operationLevelMetricsConfig</code>: Controls how operation metrics will
|
|
2044
|
-
* CloudWatch. Operation metrics include:</p>
|
|
2457
|
+
* <code>operationLevelMetricsConfig</code>: Controls how operation metrics will
|
|
2458
|
+
* be emitted to CloudWatch. Operation metrics include:</p>
|
|
2045
2459
|
* <ul>
|
|
2046
2460
|
* <li>
|
|
2047
|
-
* <p>Requests: The number of times a specified GraphQL operation was
|
|
2461
|
+
* <p>Requests: The number of times a specified GraphQL operation was
|
|
2462
|
+
* called.</p>
|
|
2048
2463
|
* </li>
|
|
2049
2464
|
* <li>
|
|
2050
|
-
* <p>GraphQL errors: The number of GraphQL errors that occurred during a
|
|
2051
|
-
* operation.</p>
|
|
2465
|
+
* <p>GraphQL errors: The number of GraphQL errors that occurred during a
|
|
2466
|
+
* specified GraphQL operation.</p>
|
|
2052
2467
|
* </li>
|
|
2053
2468
|
* </ul>
|
|
2054
|
-
* <p>Metrics will be recorded by API ID and operation name. You can set the value to
|
|
2055
|
-
*
|
|
2469
|
+
* <p>Metrics will be recorded by API ID and operation name. You can set the value to
|
|
2470
|
+
* <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
2056
2471
|
* </li>
|
|
2057
2472
|
* </ol>
|
|
2058
2473
|
* @public
|
|
2059
2474
|
*/
|
|
2060
2475
|
export interface EnhancedMetricsConfig {
|
|
2061
2476
|
/**
|
|
2062
|
-
* <p>Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics
|
|
2477
|
+
* <p>Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics
|
|
2478
|
+
* include:</p>
|
|
2063
2479
|
* <ul>
|
|
2064
2480
|
* <li>
|
|
2065
2481
|
* <p>GraphQL errors: The number of GraphQL errors that occurred.</p>
|
|
@@ -2077,26 +2493,27 @@ export interface EnhancedMetricsConfig {
|
|
|
2077
2493
|
* <p>Cache misses: The number of cache misses during a request.</p>
|
|
2078
2494
|
* </li>
|
|
2079
2495
|
* </ul>
|
|
2080
|
-
* <p>These metrics can be emitted to CloudWatch per resolver or for all resolvers in the
|
|
2081
|
-
* recorded by API ID and resolver name.
|
|
2082
|
-
*
|
|
2496
|
+
* <p>These metrics can be emitted to CloudWatch per resolver or for all resolvers in the
|
|
2497
|
+
* request. Metrics will be recorded by API ID and resolver name.
|
|
2498
|
+
* <code>resolverLevelMetricsBehavior</code> accepts one of these values at a time:</p>
|
|
2083
2499
|
* <ul>
|
|
2084
2500
|
* <li>
|
|
2085
2501
|
* <p>
|
|
2086
|
-
* <code>FULL_REQUEST_RESOLVER_METRICS</code>: Records and emits metric data for
|
|
2087
|
-
* request.</p>
|
|
2502
|
+
* <code>FULL_REQUEST_RESOLVER_METRICS</code>: Records and emits metric data for
|
|
2503
|
+
* all resolvers in the request.</p>
|
|
2088
2504
|
* </li>
|
|
2089
2505
|
* <li>
|
|
2090
2506
|
* <p>
|
|
2091
|
-
* <code>PER_RESOLVER_METRICS</code>: Records and emits metric data for resolvers
|
|
2092
|
-
*
|
|
2507
|
+
* <code>PER_RESOLVER_METRICS</code>: Records and emits metric data for resolvers
|
|
2508
|
+
* that have the <code>metricsConfig</code> value set to <code>ENABLED</code>.</p>
|
|
2093
2509
|
* </li>
|
|
2094
2510
|
* </ul>
|
|
2095
2511
|
* @public
|
|
2096
2512
|
*/
|
|
2097
2513
|
resolverLevelMetricsBehavior: ResolverLevelMetricsBehavior | undefined;
|
|
2098
2514
|
/**
|
|
2099
|
-
* <p>Controls how data source metrics will be emitted to CloudWatch. Data source metrics
|
|
2515
|
+
* <p>Controls how data source metrics will be emitted to CloudWatch. Data source metrics
|
|
2516
|
+
* include:</p>
|
|
2100
2517
|
* <ul>
|
|
2101
2518
|
* <li>
|
|
2102
2519
|
* <p>Requests: The number of invocations that occured during a request.</p>
|
|
@@ -2105,40 +2522,45 @@ export interface EnhancedMetricsConfig {
|
|
|
2105
2522
|
* <p>Latency: The time to complete a data source invocation.</p>
|
|
2106
2523
|
* </li>
|
|
2107
2524
|
* <li>
|
|
2108
|
-
* <p>Errors:
|
|
2525
|
+
* <p>Errors: The number of errors that occurred during a data source
|
|
2526
|
+
* invocation.</p>
|
|
2109
2527
|
* </li>
|
|
2110
2528
|
* </ul>
|
|
2111
|
-
* <p>These metrics can be emitted to CloudWatch per data source or for all data sources in
|
|
2112
|
-
* will be recorded by API ID and data source name.
|
|
2113
|
-
*
|
|
2529
|
+
* <p>These metrics can be emitted to CloudWatch per data source or for all data sources in
|
|
2530
|
+
* the request. Metrics will be recorded by API ID and data source name.
|
|
2531
|
+
* <code>dataSourceLevelMetricsBehavior</code> accepts one of these values at a
|
|
2532
|
+
* time:</p>
|
|
2114
2533
|
* <ul>
|
|
2115
2534
|
* <li>
|
|
2116
2535
|
* <p>
|
|
2117
|
-
* <code>FULL_REQUEST_DATA_SOURCE_METRICS</code>: Records and emits metric data
|
|
2118
|
-
* in the request.</p>
|
|
2536
|
+
* <code>FULL_REQUEST_DATA_SOURCE_METRICS</code>: Records and emits metric data
|
|
2537
|
+
* for all data sources in the request.</p>
|
|
2119
2538
|
* </li>
|
|
2120
2539
|
* <li>
|
|
2121
2540
|
* <p>
|
|
2122
|
-
* <code>PER_DATA_SOURCE_METRICS</code>: Records and emits metric data for data
|
|
2123
|
-
*
|
|
2541
|
+
* <code>PER_DATA_SOURCE_METRICS</code>: Records and emits metric data for data
|
|
2542
|
+
* sources that have the <code>metricsConfig</code> value set to
|
|
2543
|
+
* <code>ENABLED</code>.</p>
|
|
2124
2544
|
* </li>
|
|
2125
2545
|
* </ul>
|
|
2126
2546
|
* @public
|
|
2127
2547
|
*/
|
|
2128
2548
|
dataSourceLevelMetricsBehavior: DataSourceLevelMetricsBehavior | undefined;
|
|
2129
2549
|
/**
|
|
2130
|
-
* <p> Controls how operation metrics will be emitted to CloudWatch. Operation metrics
|
|
2550
|
+
* <p> Controls how operation metrics will be emitted to CloudWatch. Operation metrics
|
|
2551
|
+
* include:</p>
|
|
2131
2552
|
* <ul>
|
|
2132
2553
|
* <li>
|
|
2133
|
-
* <p>Requests: The number of times a specified GraphQL operation was
|
|
2554
|
+
* <p>Requests: The number of times a specified GraphQL operation was
|
|
2555
|
+
* called.</p>
|
|
2134
2556
|
* </li>
|
|
2135
2557
|
* <li>
|
|
2136
|
-
* <p>GraphQL errors: The number of GraphQL errors that occurred during a specified
|
|
2137
|
-
* operation.</p>
|
|
2558
|
+
* <p>GraphQL errors: The number of GraphQL errors that occurred during a specified
|
|
2559
|
+
* GraphQL operation.</p>
|
|
2138
2560
|
* </li>
|
|
2139
2561
|
* </ul>
|
|
2140
|
-
* <p>Metrics will be recorded by API ID and operation name. You can set the value to
|
|
2141
|
-
* <code>DISABLED</code>.</p>
|
|
2562
|
+
* <p>Metrics will be recorded by API ID and operation name. You can set the value to
|
|
2563
|
+
* <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
2142
2564
|
* @public
|
|
2143
2565
|
*/
|
|
2144
2566
|
operationLevelMetricsConfig: OperationLevelMetricsConfig | undefined;
|
|
@@ -2176,17 +2598,17 @@ export type FieldLogLevel = (typeof FieldLogLevel)[keyof typeof FieldLogLevel];
|
|
|
2176
2598
|
*/
|
|
2177
2599
|
export interface LogConfig {
|
|
2178
2600
|
/**
|
|
2179
|
-
* <p>The field logging level. Values can be NONE, ERROR,
|
|
2601
|
+
* <p>The field logging level. Values can be NONE, ERROR, or ALL.</p>
|
|
2180
2602
|
* <ul>
|
|
2181
2603
|
* <li>
|
|
2182
2604
|
* <p>
|
|
2183
|
-
* <b>NONE</b>: No field-level logs are
|
|
2605
|
+
* <b>NONE</b>: No field-level logs are
|
|
2606
|
+
* captured.</p>
|
|
2184
2607
|
* </li>
|
|
2185
2608
|
* <li>
|
|
2186
2609
|
* <p>
|
|
2187
|
-
* <b>ERROR</b>: Logs the following information
|
|
2188
|
-
*
|
|
2189
|
-
* category:</p>
|
|
2610
|
+
* <b>ERROR</b>: Logs the following information only for
|
|
2611
|
+
* the fields that are in error:</p>
|
|
2190
2612
|
* <ul>
|
|
2191
2613
|
* <li>
|
|
2192
2614
|
* <p>The error section in the server response.</p>
|
|
@@ -2195,56 +2617,21 @@ export interface LogConfig {
|
|
|
2195
2617
|
* <p>Field-level errors.</p>
|
|
2196
2618
|
* </li>
|
|
2197
2619
|
* <li>
|
|
2198
|
-
* <p>The generated request/response functions that got resolved for error
|
|
2620
|
+
* <p>The generated request/response functions that got resolved for error
|
|
2621
|
+
* fields.</p>
|
|
2199
2622
|
* </li>
|
|
2200
2623
|
* </ul>
|
|
2201
2624
|
* </li>
|
|
2202
2625
|
* <li>
|
|
2203
2626
|
* <p>
|
|
2204
|
-
* <b>
|
|
2205
|
-
*
|
|
2206
|
-
* <ul>
|
|
2207
|
-
* <li>
|
|
2208
|
-
* <p>Info-level messages.</p>
|
|
2209
|
-
* </li>
|
|
2210
|
-
* <li>
|
|
2211
|
-
* <p>The user messages sent through <code>$util.log.info</code> and
|
|
2212
|
-
* <code>console.log</code>.</p>
|
|
2213
|
-
* </li>
|
|
2214
|
-
* <li>
|
|
2215
|
-
* <p>Field-level tracing and mapping logs are not shown.</p>
|
|
2216
|
-
* </li>
|
|
2217
|
-
* </ul>
|
|
2218
|
-
* </li>
|
|
2219
|
-
* <li>
|
|
2220
|
-
* <p>
|
|
2221
|
-
* <b>DEBUG</b>: Logs the following information
|
|
2222
|
-
* <b>only</b> for the fields that are in the debug, info,
|
|
2223
|
-
* and error categories:</p>
|
|
2224
|
-
* <ul>
|
|
2225
|
-
* <li>
|
|
2226
|
-
* <p>Debug-level messages.</p>
|
|
2227
|
-
* </li>
|
|
2228
|
-
* <li>
|
|
2229
|
-
* <p>The user messages sent through <code>$util.log.info</code>,
|
|
2230
|
-
* <code>$util.log.debug</code>, <code>console.log</code>, and
|
|
2231
|
-
* <code>console.debug</code>.</p>
|
|
2232
|
-
* </li>
|
|
2233
|
-
* <li>
|
|
2234
|
-
* <p>Field-level tracing and mapping logs are not shown.</p>
|
|
2235
|
-
* </li>
|
|
2236
|
-
* </ul>
|
|
2237
|
-
* </li>
|
|
2238
|
-
* <li>
|
|
2239
|
-
* <p>
|
|
2240
|
-
* <b>ALL</b>: The following information is logged for all fields in the
|
|
2241
|
-
* query:</p>
|
|
2627
|
+
* <b>ALL</b>: The following information is logged for
|
|
2628
|
+
* all fields in the query:</p>
|
|
2242
2629
|
* <ul>
|
|
2243
2630
|
* <li>
|
|
2244
2631
|
* <p>Field-level tracing information.</p>
|
|
2245
2632
|
* </li>
|
|
2246
2633
|
* <li>
|
|
2247
|
-
* <p>The generated request/response functions that
|
|
2634
|
+
* <p>The generated request/response functions that got resolved for each
|
|
2248
2635
|
* field.</p>
|
|
2249
2636
|
* </li>
|
|
2250
2637
|
* </ul>
|
|
@@ -2254,14 +2641,14 @@ export interface LogConfig {
|
|
|
2254
2641
|
*/
|
|
2255
2642
|
fieldLogLevel: FieldLogLevel | undefined;
|
|
2256
2643
|
/**
|
|
2257
|
-
* <p>The service role that AppSync assumes to publish to CloudWatch
|
|
2258
|
-
* account.</p>
|
|
2644
|
+
* <p>The service role that AppSync assumes to publish to CloudWatch
|
|
2645
|
+
* logs in your account.</p>
|
|
2259
2646
|
* @public
|
|
2260
2647
|
*/
|
|
2261
2648
|
cloudWatchLogsRoleArn: string | undefined;
|
|
2262
2649
|
/**
|
|
2263
|
-
* <p>Set to TRUE to exclude sections that contain information such as headers, context, and
|
|
2264
|
-
* templates, regardless of logging level.</p>
|
|
2650
|
+
* <p>Set to TRUE to exclude sections that contain information such as headers, context, and
|
|
2651
|
+
* evaluated mapping templates, regardless of logging level.</p>
|
|
2265
2652
|
* @public
|
|
2266
2653
|
*/
|
|
2267
2654
|
excludeVerboseContent?: boolean;
|
|
@@ -2294,14 +2681,14 @@ export interface UserPoolConfig {
|
|
|
2294
2681
|
*/
|
|
2295
2682
|
awsRegion: string | undefined;
|
|
2296
2683
|
/**
|
|
2297
|
-
* <p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool
|
|
2298
|
-
*
|
|
2684
|
+
* <p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool
|
|
2685
|
+
* configuration.</p>
|
|
2299
2686
|
* @public
|
|
2300
2687
|
*/
|
|
2301
2688
|
defaultAction: DefaultAction | undefined;
|
|
2302
2689
|
/**
|
|
2303
|
-
* <p>A regular expression for validating the incoming Amazon Cognito user pool app client
|
|
2304
|
-
* isn't set, no filtering is applied.</p>
|
|
2690
|
+
* <p>A regular expression for validating the incoming Amazon Cognito user pool app client
|
|
2691
|
+
* ID. If this value isn't set, no filtering is applied.</p>
|
|
2305
2692
|
* @public
|
|
2306
2693
|
*/
|
|
2307
2694
|
appIdClientRegex?: string;
|
|
@@ -2333,8 +2720,8 @@ export interface CreateGraphqlApiRequest {
|
|
|
2333
2720
|
*/
|
|
2334
2721
|
logConfig?: LogConfig;
|
|
2335
2722
|
/**
|
|
2336
|
-
* <p>The authentication type: API key, Identity and Access Management (IAM), OpenID
|
|
2337
|
-
*
|
|
2723
|
+
* <p>The authentication type: API key, Identity and Access Management (IAM), OpenID
|
|
2724
|
+
* Connect (OIDC), Amazon Cognito user pools, or Lambda.</p>
|
|
2338
2725
|
* @public
|
|
2339
2726
|
*/
|
|
2340
2727
|
authenticationType: AuthenticationType | undefined;
|
|
@@ -2354,12 +2741,14 @@ export interface CreateGraphqlApiRequest {
|
|
|
2354
2741
|
*/
|
|
2355
2742
|
tags?: Record<string, string>;
|
|
2356
2743
|
/**
|
|
2357
|
-
* <p>A list of additional authentication providers for the <code>GraphqlApi</code>
|
|
2744
|
+
* <p>A list of additional authentication providers for the <code>GraphqlApi</code>
|
|
2745
|
+
* API.</p>
|
|
2358
2746
|
* @public
|
|
2359
2747
|
*/
|
|
2360
2748
|
additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
|
|
2361
2749
|
/**
|
|
2362
|
-
* <p>A flag indicating whether to use X-Ray tracing for the
|
|
2750
|
+
* <p>A flag indicating whether to use X-Ray tracing for the
|
|
2751
|
+
* <code>GraphqlApi</code>.</p>
|
|
2363
2752
|
* @public
|
|
2364
2753
|
*/
|
|
2365
2754
|
xrayEnabled?: boolean;
|
|
@@ -2369,25 +2758,27 @@ export interface CreateGraphqlApiRequest {
|
|
|
2369
2758
|
*/
|
|
2370
2759
|
lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
|
|
2371
2760
|
/**
|
|
2372
|
-
* <p>
|
|
2373
|
-
*
|
|
2374
|
-
* once the API has been created.</p>
|
|
2761
|
+
* <p>The value that indicates whether the GraphQL API is a standard API
|
|
2762
|
+
* (<code>GRAPHQL</code>) or merged API (<code>MERGED</code>).</p>
|
|
2375
2763
|
* @public
|
|
2376
2764
|
*/
|
|
2377
|
-
|
|
2765
|
+
apiType?: GraphQLApiType;
|
|
2378
2766
|
/**
|
|
2379
|
-
* <p>The
|
|
2380
|
-
*
|
|
2767
|
+
* <p>The Identity and Access Management service role ARN for a merged API. The AppSync
|
|
2768
|
+
* service assumes this role on behalf of the Merged API to validate access to source APIs at
|
|
2769
|
+
* runtime and to prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with
|
|
2770
|
+
* the source API changes automatically.</p>
|
|
2381
2771
|
* @public
|
|
2382
2772
|
*/
|
|
2383
|
-
|
|
2773
|
+
mergedApiExecutionRoleArn?: string;
|
|
2384
2774
|
/**
|
|
2385
|
-
* <p>
|
|
2386
|
-
*
|
|
2387
|
-
* <code>
|
|
2775
|
+
* <p>Sets the value of the GraphQL API to public (<code>GLOBAL</code>) or private
|
|
2776
|
+
* (<code>PRIVATE</code>). If no value is provided, the visibility will be set to
|
|
2777
|
+
* <code>GLOBAL</code> by default. This value cannot be changed once the API has been
|
|
2778
|
+
* created.</p>
|
|
2388
2779
|
* @public
|
|
2389
2780
|
*/
|
|
2390
|
-
|
|
2781
|
+
visibility?: GraphQLApiVisibility;
|
|
2391
2782
|
/**
|
|
2392
2783
|
* <p>The owner contact information for an API resource.</p>
|
|
2393
2784
|
* <p>This field accepts any string input with a length of 0 - 256 characters.</p>
|
|
@@ -2395,30 +2786,32 @@ export interface CreateGraphqlApiRequest {
|
|
|
2395
2786
|
*/
|
|
2396
2787
|
ownerContact?: string;
|
|
2397
2788
|
/**
|
|
2398
|
-
* <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable
|
|
2399
|
-
*
|
|
2400
|
-
*
|
|
2401
|
-
* field is
|
|
2402
|
-
*
|
|
2403
|
-
*
|
|
2789
|
+
* <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable
|
|
2790
|
+
* (<code>DISABLED</code>) introspection. If no value is provided, the introspection
|
|
2791
|
+
* configuration will be set to <code>ENABLED</code> by default. This field will produce an
|
|
2792
|
+
* error if the operation attempts to use the introspection feature while this field is
|
|
2793
|
+
* disabled.</p>
|
|
2794
|
+
* <p>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL introspection</a>.</p>
|
|
2404
2795
|
* @public
|
|
2405
2796
|
*/
|
|
2406
2797
|
introspectionConfig?: GraphQLApiIntrospectionConfig;
|
|
2407
2798
|
/**
|
|
2408
|
-
* <p>The maximum depth a query can have in a single request. Depth refers to the amount of
|
|
2409
|
-
* in the body of query. The default value is <code>0</code> (or
|
|
2410
|
-
* limit. If you set a limit, it can be between
|
|
2411
|
-
*
|
|
2412
|
-
*
|
|
2413
|
-
*
|
|
2799
|
+
* <p>The maximum depth a query can have in a single request. Depth refers to the amount of
|
|
2800
|
+
* nested levels allowed in the body of query. The default value is <code>0</code> (or
|
|
2801
|
+
* unspecified), which indicates there's no depth limit. If you set a limit, it can be between
|
|
2802
|
+
* <code>1</code> and <code>75</code> nested levels. This field will produce a limit error
|
|
2803
|
+
* if the operation falls out of bounds.</p>
|
|
2804
|
+
* <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field
|
|
2805
|
+
* produces an error, the error will be thrown upwards to the first nullable field
|
|
2806
|
+
* available.</p>
|
|
2414
2807
|
* @public
|
|
2415
2808
|
*/
|
|
2416
2809
|
queryDepthLimit?: number;
|
|
2417
2810
|
/**
|
|
2418
|
-
* <p>The maximum number of resolvers that can be invoked in a single request. The default
|
|
2419
|
-
* (or unspecified), which will set the limit to <code>10000</code>.
|
|
2420
|
-
* between <code>1</code> and <code>10000</code>. This
|
|
2421
|
-
* of bounds.</p>
|
|
2811
|
+
* <p>The maximum number of resolvers that can be invoked in a single request. The default
|
|
2812
|
+
* value is <code>0</code> (or unspecified), which will set the limit to <code>10000</code>.
|
|
2813
|
+
* When specified, the limit value can be between <code>1</code> and <code>10000</code>. This
|
|
2814
|
+
* field will produce a limit error if the operation falls out of bounds.</p>
|
|
2422
2815
|
* @public
|
|
2423
2816
|
*/
|
|
2424
2817
|
resolverCountLimit?: number;
|
|
@@ -2479,18 +2872,20 @@ export interface GraphqlApi {
|
|
|
2479
2872
|
*/
|
|
2480
2873
|
tags?: Record<string, string>;
|
|
2481
2874
|
/**
|
|
2482
|
-
* <p>A list of additional authentication providers for the <code>GraphqlApi</code>
|
|
2875
|
+
* <p>A list of additional authentication providers for the <code>GraphqlApi</code>
|
|
2876
|
+
* API.</p>
|
|
2483
2877
|
* @public
|
|
2484
2878
|
*/
|
|
2485
2879
|
additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
|
|
2486
2880
|
/**
|
|
2487
|
-
* <p>A flag indicating whether to use X-Ray tracing for this
|
|
2881
|
+
* <p>A flag indicating whether to use X-Ray tracing for this
|
|
2882
|
+
* <code>GraphqlApi</code>.</p>
|
|
2488
2883
|
* @public
|
|
2489
2884
|
*/
|
|
2490
2885
|
xrayEnabled?: boolean;
|
|
2491
2886
|
/**
|
|
2492
2887
|
* <p>The ARN of the WAF access control list (ACL) associated with this
|
|
2493
|
-
*
|
|
2888
|
+
* <code>GraphqlApi</code>, if one exists.</p>
|
|
2494
2889
|
* @public
|
|
2495
2890
|
*/
|
|
2496
2891
|
wafWebAclArn?: string;
|
|
@@ -2505,22 +2900,24 @@ export interface GraphqlApi {
|
|
|
2505
2900
|
*/
|
|
2506
2901
|
dns?: Record<string, string>;
|
|
2507
2902
|
/**
|
|
2508
|
-
* <p>Sets the value of the GraphQL API to public (<code>GLOBAL</code>) or private
|
|
2509
|
-
*
|
|
2510
|
-
*
|
|
2903
|
+
* <p>Sets the value of the GraphQL API to public (<code>GLOBAL</code>) or private
|
|
2904
|
+
* (<code>PRIVATE</code>). If no value is provided, the visibility will be set to
|
|
2905
|
+
* <code>GLOBAL</code> by default. This value cannot be changed once the API has been
|
|
2906
|
+
* created.</p>
|
|
2511
2907
|
* @public
|
|
2512
2908
|
*/
|
|
2513
2909
|
visibility?: GraphQLApiVisibility;
|
|
2514
2910
|
/**
|
|
2515
|
-
* <p>The value that indicates whether the GraphQL API is a standard API
|
|
2516
|
-
*
|
|
2911
|
+
* <p>The value that indicates whether the GraphQL API is a standard API
|
|
2912
|
+
* (<code>GRAPHQL</code>) or merged API (<code>MERGED</code>).</p>
|
|
2517
2913
|
* @public
|
|
2518
2914
|
*/
|
|
2519
2915
|
apiType?: GraphQLApiType;
|
|
2520
2916
|
/**
|
|
2521
|
-
* <p>The Identity and Access Management service role ARN for a merged API. The AppSync
|
|
2522
|
-
* on behalf of the Merged API to validate access to source APIs at
|
|
2523
|
-
*
|
|
2917
|
+
* <p>The Identity and Access Management service role ARN for a merged API. The AppSync
|
|
2918
|
+
* service assumes this role on behalf of the Merged API to validate access to source APIs at
|
|
2919
|
+
* runtime and to prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with
|
|
2920
|
+
* the source API changes automatically.</p>
|
|
2524
2921
|
* @public
|
|
2525
2922
|
*/
|
|
2526
2923
|
mergedApiExecutionRoleArn?: string;
|
|
@@ -2536,30 +2933,32 @@ export interface GraphqlApi {
|
|
|
2536
2933
|
*/
|
|
2537
2934
|
ownerContact?: string;
|
|
2538
2935
|
/**
|
|
2539
|
-
* <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable
|
|
2540
|
-
*
|
|
2541
|
-
*
|
|
2542
|
-
* field is
|
|
2543
|
-
*
|
|
2544
|
-
*
|
|
2936
|
+
* <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable
|
|
2937
|
+
* (<code>DISABLED</code>) introspection. If no value is provided, the introspection
|
|
2938
|
+
* configuration will be set to <code>ENABLED</code> by default. This field will produce an
|
|
2939
|
+
* error if the operation attempts to use the introspection feature while this field is
|
|
2940
|
+
* disabled.</p>
|
|
2941
|
+
* <p>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL introspection</a>.</p>
|
|
2545
2942
|
* @public
|
|
2546
2943
|
*/
|
|
2547
2944
|
introspectionConfig?: GraphQLApiIntrospectionConfig;
|
|
2548
2945
|
/**
|
|
2549
|
-
* <p>The maximum depth a query can have in a single request. Depth refers to the amount of
|
|
2550
|
-
* in the body of query. The default value is <code>0</code> (or
|
|
2551
|
-
* limit. If you set a limit, it can be between
|
|
2552
|
-
*
|
|
2553
|
-
*
|
|
2554
|
-
*
|
|
2946
|
+
* <p>The maximum depth a query can have in a single request. Depth refers to the amount of
|
|
2947
|
+
* nested levels allowed in the body of query. The default value is <code>0</code> (or
|
|
2948
|
+
* unspecified), which indicates there's no depth limit. If you set a limit, it can be between
|
|
2949
|
+
* <code>1</code> and <code>75</code> nested levels. This field will produce a limit error
|
|
2950
|
+
* if the operation falls out of bounds.</p>
|
|
2951
|
+
* <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field
|
|
2952
|
+
* produces an error, the error will be thrown upwards to the first nullable field
|
|
2953
|
+
* available.</p>
|
|
2555
2954
|
* @public
|
|
2556
2955
|
*/
|
|
2557
2956
|
queryDepthLimit?: number;
|
|
2558
2957
|
/**
|
|
2559
|
-
* <p>The maximum number of resolvers that can be invoked in a single request. The default
|
|
2560
|
-
* (or unspecified), which will set the limit to <code>10000</code>.
|
|
2561
|
-
* between <code>1</code> and <code>10000</code>. This
|
|
2562
|
-
* of bounds.</p>
|
|
2958
|
+
* <p>The maximum number of resolvers that can be invoked in a single request. The default
|
|
2959
|
+
* value is <code>0</code> (or unspecified), which will set the limit to <code>10000</code>.
|
|
2960
|
+
* When specified, the limit value can be between <code>1</code> and <code>10000</code>. This
|
|
2961
|
+
* field will produce a limit error if the operation falls out of bounds.</p>
|
|
2563
2962
|
* @public
|
|
2564
2963
|
*/
|
|
2565
2964
|
resolverCountLimit?: number;
|
|
@@ -2592,8 +2991,8 @@ export interface CachingConfig {
|
|
|
2592
2991
|
ttl: number | undefined;
|
|
2593
2992
|
/**
|
|
2594
2993
|
* <p>The caching keys for a resolver that has caching activated.</p>
|
|
2595
|
-
* <p>Valid values are entries from the <code>$context.arguments</code>,
|
|
2596
|
-
* <code>$context.identity</code> maps.</p>
|
|
2994
|
+
* <p>Valid values are entries from the <code>$context.arguments</code>,
|
|
2995
|
+
* <code>$context.source</code>, and <code>$context.identity</code> maps.</p>
|
|
2597
2996
|
* @public
|
|
2598
2997
|
*/
|
|
2599
2998
|
cachingKeys?: string[];
|
|
@@ -2659,10 +3058,12 @@ export interface CreateResolverRequest {
|
|
|
2659
3058
|
dataSourceName?: string;
|
|
2660
3059
|
/**
|
|
2661
3060
|
* <p>The mapping template to use for requests.</p>
|
|
2662
|
-
* <p>A resolver uses a request mapping template to convert a GraphQL expression into a format
|
|
2663
|
-
* can understand. Mapping templates are written in Apache Velocity
|
|
2664
|
-
*
|
|
2665
|
-
*
|
|
3061
|
+
* <p>A resolver uses a request mapping template to convert a GraphQL expression into a format
|
|
3062
|
+
* that a data source can understand. Mapping templates are written in Apache Velocity
|
|
3063
|
+
* Template Language (VTL).</p>
|
|
3064
|
+
* <p>VTL request mapping templates are optional when using an Lambda data
|
|
3065
|
+
* source. For all other data sources, VTL request and response mapping templates are
|
|
3066
|
+
* required.</p>
|
|
2666
3067
|
* @public
|
|
2667
3068
|
*/
|
|
2668
3069
|
requestMappingTemplate?: string;
|
|
@@ -2676,14 +3077,16 @@ export interface CreateResolverRequest {
|
|
|
2676
3077
|
* <ul>
|
|
2677
3078
|
* <li>
|
|
2678
3079
|
* <p>
|
|
2679
|
-
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is
|
|
2680
|
-
* resolver type. You can use a UNIT resolver to run a GraphQL query against
|
|
3080
|
+
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is
|
|
3081
|
+
* the default resolver type. You can use a UNIT resolver to run a GraphQL query against
|
|
3082
|
+
* a single data source.</p>
|
|
2681
3083
|
* </li>
|
|
2682
3084
|
* <li>
|
|
2683
3085
|
* <p>
|
|
2684
|
-
* <b>PIPELINE</b>: A PIPELINE resolver type. You can
|
|
2685
|
-
* resolver to invoke a series of <code>Function</code> objects in a
|
|
2686
|
-
* resolver to run a GraphQL query against
|
|
3086
|
+
* <b>PIPELINE</b>: A PIPELINE resolver type. You can
|
|
3087
|
+
* use a PIPELINE resolver to invoke a series of <code>Function</code> objects in a
|
|
3088
|
+
* serial manner. You can use a pipeline resolver to run a GraphQL query against
|
|
3089
|
+
* multiple data sources.</p>
|
|
2687
3090
|
* </li>
|
|
2688
3091
|
* </ul>
|
|
2689
3092
|
* @public
|
|
@@ -2710,24 +3113,25 @@ export interface CreateResolverRequest {
|
|
|
2710
3113
|
*/
|
|
2711
3114
|
maxBatchSize?: number;
|
|
2712
3115
|
/**
|
|
2713
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
2714
|
-
*
|
|
2715
|
-
* also be specified.</p>
|
|
3116
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
|
|
3117
|
+
* that if a runtime is specified, code must also be specified.</p>
|
|
2716
3118
|
* @public
|
|
2717
3119
|
*/
|
|
2718
3120
|
runtime?: AppSyncRuntime;
|
|
2719
3121
|
/**
|
|
2720
|
-
* <p>The <code>resolver</code> code that contains the request and response functions. When
|
|
2721
|
-
*
|
|
3122
|
+
* <p>The <code>resolver</code> code that contains the request and response functions. When
|
|
3123
|
+
* code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
|
|
3124
|
+
* <code>APPSYNC_JS</code>.</p>
|
|
2722
3125
|
* @public
|
|
2723
3126
|
*/
|
|
2724
3127
|
code?: string;
|
|
2725
3128
|
/**
|
|
2726
|
-
* <p>Enables or disables enhanced resolver metrics for specified resolvers. Note that
|
|
2727
|
-
*
|
|
2728
|
-
* <code>
|
|
2729
|
-
* <code>
|
|
2730
|
-
*
|
|
3129
|
+
* <p>Enables or disables enhanced resolver metrics for specified resolvers. Note that
|
|
3130
|
+
* <code>metricsConfig</code> won't be used unless the
|
|
3131
|
+
* <code>resolverLevelMetricsBehavior</code> value is set to
|
|
3132
|
+
* <code>PER_RESOLVER_METRICS</code>. If the <code>resolverLevelMetricsBehavior</code> is
|
|
3133
|
+
* set to <code>FULL_REQUEST_RESOLVER_METRICS</code> instead, <code>metricsConfig</code> will
|
|
3134
|
+
* be ignored. However, you can still set its value.</p>
|
|
2731
3135
|
* <p>
|
|
2732
3136
|
* <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
2733
3137
|
* @public
|
|
@@ -2774,14 +3178,16 @@ export interface Resolver {
|
|
|
2774
3178
|
* <ul>
|
|
2775
3179
|
* <li>
|
|
2776
3180
|
* <p>
|
|
2777
|
-
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is
|
|
2778
|
-
* resolver type. You can use a UNIT resolver to run a GraphQL query against
|
|
3181
|
+
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is
|
|
3182
|
+
* the default resolver type. You can use a UNIT resolver to run a GraphQL query against
|
|
3183
|
+
* a single data source.</p>
|
|
2779
3184
|
* </li>
|
|
2780
3185
|
* <li>
|
|
2781
3186
|
* <p>
|
|
2782
|
-
* <b>PIPELINE</b>: A PIPELINE resolver type. You can
|
|
2783
|
-
* resolver to invoke a series of <code>Function</code> objects in a
|
|
2784
|
-
* resolver to run a GraphQL query against
|
|
3187
|
+
* <b>PIPELINE</b>: A PIPELINE resolver type. You can
|
|
3188
|
+
* use a PIPELINE resolver to invoke a series of <code>Function</code> objects in a
|
|
3189
|
+
* serial manner. You can use a pipeline resolver to run a GraphQL query against
|
|
3190
|
+
* multiple data sources.</p>
|
|
2785
3191
|
* </li>
|
|
2786
3192
|
* </ul>
|
|
2787
3193
|
* @public
|
|
@@ -2808,24 +3214,25 @@ export interface Resolver {
|
|
|
2808
3214
|
*/
|
|
2809
3215
|
maxBatchSize?: number;
|
|
2810
3216
|
/**
|
|
2811
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
2812
|
-
*
|
|
2813
|
-
* also be specified.</p>
|
|
3217
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
|
|
3218
|
+
* that if a runtime is specified, code must also be specified.</p>
|
|
2814
3219
|
* @public
|
|
2815
3220
|
*/
|
|
2816
3221
|
runtime?: AppSyncRuntime;
|
|
2817
3222
|
/**
|
|
2818
|
-
* <p>The <code>resolver</code> code that contains the request and response functions. When
|
|
2819
|
-
*
|
|
3223
|
+
* <p>The <code>resolver</code> code that contains the request and response functions. When
|
|
3224
|
+
* code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
|
|
3225
|
+
* <code>APPSYNC_JS</code>.</p>
|
|
2820
3226
|
* @public
|
|
2821
3227
|
*/
|
|
2822
3228
|
code?: string;
|
|
2823
3229
|
/**
|
|
2824
|
-
* <p>Enables or disables enhanced resolver metrics for specified resolvers. Note that
|
|
2825
|
-
*
|
|
2826
|
-
*
|
|
2827
|
-
*
|
|
2828
|
-
*
|
|
3230
|
+
* <p>Enables or disables enhanced resolver metrics for specified resolvers. Note that
|
|
3231
|
+
* <code>metricsConfig</code> won't be used unless the
|
|
3232
|
+
* <code>resolverLevelMetricsBehavior</code> value is set to
|
|
3233
|
+
* <code>PER_RESOLVER_METRICS</code>. If the <code>resolverLevelMetricsBehavior</code> is
|
|
3234
|
+
* set to <code>FULL_REQUEST_RESOLVER_METRICS</code> instead, <code>metricsConfig</code> will
|
|
3235
|
+
* be ignored. However, you can still set its value.</p>
|
|
2829
3236
|
* <p>
|
|
2830
3237
|
* <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
2831
3238
|
* @public
|
|
@@ -2917,6 +3324,21 @@ export interface CreateTypeResponse {
|
|
|
2917
3324
|
*/
|
|
2918
3325
|
type?: Type;
|
|
2919
3326
|
}
|
|
3327
|
+
/**
|
|
3328
|
+
* @public
|
|
3329
|
+
*/
|
|
3330
|
+
export interface DeleteApiRequest {
|
|
3331
|
+
/**
|
|
3332
|
+
* <p>The <code>Api</code> ID.</p>
|
|
3333
|
+
* @public
|
|
3334
|
+
*/
|
|
3335
|
+
apiId: string | undefined;
|
|
3336
|
+
}
|
|
3337
|
+
/**
|
|
3338
|
+
* @public
|
|
3339
|
+
*/
|
|
3340
|
+
export interface DeleteApiResponse {
|
|
3341
|
+
}
|
|
2920
3342
|
/**
|
|
2921
3343
|
* <p>Represents the input of a <code>DeleteApiCache</code> operation.</p>
|
|
2922
3344
|
* @public
|
|
@@ -2954,6 +3376,26 @@ export interface DeleteApiKeyRequest {
|
|
|
2954
3376
|
*/
|
|
2955
3377
|
export interface DeleteApiKeyResponse {
|
|
2956
3378
|
}
|
|
3379
|
+
/**
|
|
3380
|
+
* @public
|
|
3381
|
+
*/
|
|
3382
|
+
export interface DeleteChannelNamespaceRequest {
|
|
3383
|
+
/**
|
|
3384
|
+
* <p>The ID of the <code>Api</code> associated with the <code>ChannelNamespace</code>.</p>
|
|
3385
|
+
* @public
|
|
3386
|
+
*/
|
|
3387
|
+
apiId: string | undefined;
|
|
3388
|
+
/**
|
|
3389
|
+
* <p>The name of the <code>ChannelNamespace</code>.</p>
|
|
3390
|
+
* @public
|
|
3391
|
+
*/
|
|
3392
|
+
name: string | undefined;
|
|
3393
|
+
}
|
|
3394
|
+
/**
|
|
3395
|
+
* @public
|
|
3396
|
+
*/
|
|
3397
|
+
export interface DeleteChannelNamespaceResponse {
|
|
3398
|
+
}
|
|
2957
3399
|
/**
|
|
2958
3400
|
* @public
|
|
2959
3401
|
*/
|
|
@@ -3089,9 +3531,10 @@ export interface DisassociateApiResponse {
|
|
|
3089
3531
|
*/
|
|
3090
3532
|
export interface DisassociateMergedGraphqlApiRequest {
|
|
3091
3533
|
/**
|
|
3092
|
-
* <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In
|
|
3093
|
-
* APIs (especially in your account) only require the API ID value or ARN
|
|
3094
|
-
* from other accounts (cross-account use cases)
|
|
3534
|
+
* <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In
|
|
3535
|
+
* most cases, source APIs (especially in your account) only require the API ID value or ARN
|
|
3536
|
+
* of the source API. However, source APIs from other accounts (cross-account use cases)
|
|
3537
|
+
* strictly require the full resource ARN of the source API.</p>
|
|
3095
3538
|
* @public
|
|
3096
3539
|
*/
|
|
3097
3540
|
sourceApiIdentifier: string | undefined;
|
|
@@ -3116,9 +3559,10 @@ export interface DisassociateMergedGraphqlApiResponse {
|
|
|
3116
3559
|
*/
|
|
3117
3560
|
export interface DisassociateSourceGraphqlApiRequest {
|
|
3118
3561
|
/**
|
|
3119
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
3120
|
-
* APIs (especially in your account) only require the API ID value or ARN
|
|
3121
|
-
* in other accounts (cross-account use cases)
|
|
3562
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
3563
|
+
* most cases, Merged APIs (especially in your account) only require the API ID value or ARN
|
|
3564
|
+
* of the merged API. However, Merged APIs in other accounts (cross-account use cases)
|
|
3565
|
+
* strictly require the full resource ARN of the merged API.</p>
|
|
3122
3566
|
* @public
|
|
3123
3567
|
*/
|
|
3124
3568
|
mergedApiIdentifier: string | undefined;
|
|
@@ -3143,26 +3587,27 @@ export interface DisassociateSourceGraphqlApiResponse {
|
|
|
3143
3587
|
*/
|
|
3144
3588
|
export interface EvaluateCodeRequest {
|
|
3145
3589
|
/**
|
|
3146
|
-
* <p>The runtime to be used when evaluating the code. Currently, only the
|
|
3147
|
-
*
|
|
3590
|
+
* <p>The runtime to be used when evaluating the code. Currently, only the
|
|
3591
|
+
* <code>APPSYNC_JS</code> runtime is supported.</p>
|
|
3148
3592
|
* @public
|
|
3149
3593
|
*/
|
|
3150
3594
|
runtime: AppSyncRuntime | undefined;
|
|
3151
3595
|
/**
|
|
3152
|
-
* <p>The code definition to be evaluated. Note that <code>code</code> and
|
|
3153
|
-
*
|
|
3596
|
+
* <p>The code definition to be evaluated. Note that <code>code</code> and
|
|
3597
|
+
* <code>runtime</code> are both required for this action. The <code>runtime</code> value
|
|
3598
|
+
* must be <code>APPSYNC_JS</code>.</p>
|
|
3154
3599
|
* @public
|
|
3155
3600
|
*/
|
|
3156
3601
|
code: string | undefined;
|
|
3157
3602
|
/**
|
|
3158
|
-
* <p>The map that holds all of the contextual information for your resolver invocation. A
|
|
3159
|
-
*
|
|
3603
|
+
* <p>The map that holds all of the contextual information for your resolver invocation. A
|
|
3604
|
+
* <code>context</code> is required for this action.</p>
|
|
3160
3605
|
* @public
|
|
3161
3606
|
*/
|
|
3162
3607
|
context: string | undefined;
|
|
3163
3608
|
/**
|
|
3164
|
-
* <p>The function within the code to be evaluated. If provided, the valid values are
|
|
3165
|
-
* <code>response</code>.</p>
|
|
3609
|
+
* <p>The function within the code to be evaluated. If provided, the valid values are
|
|
3610
|
+
* <code>request</code> and <code>response</code>.</p>
|
|
3166
3611
|
* @public
|
|
3167
3612
|
*/
|
|
3168
3613
|
function?: string;
|
|
@@ -3198,8 +3643,8 @@ export interface EvaluateCodeResponse {
|
|
|
3198
3643
|
*/
|
|
3199
3644
|
error?: EvaluateCodeErrorDetail;
|
|
3200
3645
|
/**
|
|
3201
|
-
* <p>A list of logs that were generated by calls to <code>util.log.info</code> and
|
|
3202
|
-
*
|
|
3646
|
+
* <p>A list of logs that were generated by calls to <code>util.log.info</code> and
|
|
3647
|
+
* <code>util.log.error</code> in the evaluated code.</p>
|
|
3203
3648
|
* @public
|
|
3204
3649
|
*/
|
|
3205
3650
|
logs?: string[];
|
|
@@ -3209,21 +3654,21 @@ export interface EvaluateCodeResponse {
|
|
|
3209
3654
|
*/
|
|
3210
3655
|
export interface EvaluateMappingTemplateRequest {
|
|
3211
3656
|
/**
|
|
3212
|
-
* <p>The mapping template; this can be a request or response template. A
|
|
3213
|
-
*
|
|
3657
|
+
* <p>The mapping template; this can be a request or response template. A
|
|
3658
|
+
* <code>template</code> is required for this action.</p>
|
|
3214
3659
|
* @public
|
|
3215
3660
|
*/
|
|
3216
3661
|
template: string | undefined;
|
|
3217
3662
|
/**
|
|
3218
|
-
* <p>The map that holds all of the contextual information for your resolver invocation. A
|
|
3219
|
-
*
|
|
3663
|
+
* <p>The map that holds all of the contextual information for your resolver invocation. A
|
|
3664
|
+
* <code>context</code> is required for this action.</p>
|
|
3220
3665
|
* @public
|
|
3221
3666
|
*/
|
|
3222
3667
|
context: string | undefined;
|
|
3223
3668
|
}
|
|
3224
3669
|
/**
|
|
3225
|
-
* <p>Contains the list of errors generated. When using JavaScript, this will apply to the
|
|
3226
|
-
* function evaluation.</p>
|
|
3670
|
+
* <p>Contains the list of errors generated. When using JavaScript, this will apply to the
|
|
3671
|
+
* request or response function evaluation.</p>
|
|
3227
3672
|
* @public
|
|
3228
3673
|
*/
|
|
3229
3674
|
export interface ErrorDetail {
|
|
@@ -3248,8 +3693,8 @@ export interface EvaluateMappingTemplateResponse {
|
|
|
3248
3693
|
*/
|
|
3249
3694
|
error?: ErrorDetail;
|
|
3250
3695
|
/**
|
|
3251
|
-
* <p>A list of logs that were generated by calls to <code>util.log.info</code> and
|
|
3252
|
-
*
|
|
3696
|
+
* <p>A list of logs that were generated by calls to <code>util.log.info</code> and
|
|
3697
|
+
* <code>util.log.error</code> in the evaluated code.</p>
|
|
3253
3698
|
* @public
|
|
3254
3699
|
*/
|
|
3255
3700
|
logs?: string[];
|
|
@@ -3271,6 +3716,26 @@ export interface FlushApiCacheRequest {
|
|
|
3271
3716
|
*/
|
|
3272
3717
|
export interface FlushApiCacheResponse {
|
|
3273
3718
|
}
|
|
3719
|
+
/**
|
|
3720
|
+
* @public
|
|
3721
|
+
*/
|
|
3722
|
+
export interface GetApiRequest {
|
|
3723
|
+
/**
|
|
3724
|
+
* <p>The <code>Api</code> ID.</p>
|
|
3725
|
+
* @public
|
|
3726
|
+
*/
|
|
3727
|
+
apiId: string | undefined;
|
|
3728
|
+
}
|
|
3729
|
+
/**
|
|
3730
|
+
* @public
|
|
3731
|
+
*/
|
|
3732
|
+
export interface GetApiResponse {
|
|
3733
|
+
/**
|
|
3734
|
+
* <p>The <code>Api</code> object.</p>
|
|
3735
|
+
* @public
|
|
3736
|
+
*/
|
|
3737
|
+
api?: Api;
|
|
3738
|
+
}
|
|
3274
3739
|
/**
|
|
3275
3740
|
* @public
|
|
3276
3741
|
*/
|
|
@@ -3313,6 +3778,31 @@ export interface GetApiCacheResponse {
|
|
|
3313
3778
|
*/
|
|
3314
3779
|
apiCache?: ApiCache;
|
|
3315
3780
|
}
|
|
3781
|
+
/**
|
|
3782
|
+
* @public
|
|
3783
|
+
*/
|
|
3784
|
+
export interface GetChannelNamespaceRequest {
|
|
3785
|
+
/**
|
|
3786
|
+
* <p>The <code>Api</code> ID.</p>
|
|
3787
|
+
* @public
|
|
3788
|
+
*/
|
|
3789
|
+
apiId: string | undefined;
|
|
3790
|
+
/**
|
|
3791
|
+
* <p>The name of the <code>ChannelNamespace</code>.</p>
|
|
3792
|
+
* @public
|
|
3793
|
+
*/
|
|
3794
|
+
name: string | undefined;
|
|
3795
|
+
}
|
|
3796
|
+
/**
|
|
3797
|
+
* @public
|
|
3798
|
+
*/
|
|
3799
|
+
export interface GetChannelNamespaceResponse {
|
|
3800
|
+
/**
|
|
3801
|
+
* <p>The <code>ChannelNamespace</code> object.</p>
|
|
3802
|
+
* @public
|
|
3803
|
+
*/
|
|
3804
|
+
channelNamespace?: ChannelNamespace;
|
|
3805
|
+
}
|
|
3316
3806
|
/**
|
|
3317
3807
|
* @public
|
|
3318
3808
|
*/
|
|
@@ -3343,26 +3833,29 @@ export interface GetDataSourceResponse {
|
|
|
3343
3833
|
*/
|
|
3344
3834
|
export interface GetDataSourceIntrospectionRequest {
|
|
3345
3835
|
/**
|
|
3346
|
-
* <p>The introspection ID. Each introspection contains a unique ID that can be used to
|
|
3347
|
-
* instrospection record.</p>
|
|
3836
|
+
* <p>The introspection ID. Each introspection contains a unique ID that can be used to
|
|
3837
|
+
* reference the instrospection record.</p>
|
|
3348
3838
|
* @public
|
|
3349
3839
|
*/
|
|
3350
3840
|
introspectionId: string | undefined;
|
|
3351
3841
|
/**
|
|
3352
|
-
* <p>A boolean flag that determines whether SDL should be generated for introspected types
|
|
3353
|
-
*
|
|
3354
|
-
* The SDL only contains the type data and no additional
|
|
3842
|
+
* <p>A boolean flag that determines whether SDL should be generated for introspected types.
|
|
3843
|
+
* If set to <code>true</code>, each model will contain an <code>sdl</code> property that
|
|
3844
|
+
* contains the SDL for that type. The SDL only contains the type data and no additional
|
|
3845
|
+
* metadata or directives. </p>
|
|
3355
3846
|
* @public
|
|
3356
3847
|
*/
|
|
3357
3848
|
includeModelsSDL?: boolean;
|
|
3358
3849
|
/**
|
|
3359
|
-
* <p>Determines the number of types to be returned in a single response before paginating.
|
|
3360
|
-
* typically taken from <code>nextToken</code> value from the previous
|
|
3850
|
+
* <p>Determines the number of types to be returned in a single response before paginating.
|
|
3851
|
+
* This value is typically taken from <code>nextToken</code> value from the previous
|
|
3852
|
+
* response.</p>
|
|
3361
3853
|
* @public
|
|
3362
3854
|
*/
|
|
3363
3855
|
nextToken?: string;
|
|
3364
3856
|
/**
|
|
3365
|
-
* <p>The maximum number of introspected types that will be returned in a single
|
|
3857
|
+
* <p>The maximum number of introspected types that will be returned in a single
|
|
3858
|
+
* response.</p>
|
|
3366
3859
|
* @public
|
|
3367
3860
|
*/
|
|
3368
3861
|
maxResults?: number;
|
|
@@ -3476,7 +3969,8 @@ export interface GetGraphqlApiEnvironmentVariablesRequest {
|
|
|
3476
3969
|
*/
|
|
3477
3970
|
export interface GetGraphqlApiEnvironmentVariablesResponse {
|
|
3478
3971
|
/**
|
|
3479
|
-
* <p>The payload containing each environmental variable in the <code>"key" : "value"</code>
|
|
3972
|
+
* <p>The payload containing each environmental variable in the <code>"key" : "value"</code>
|
|
3973
|
+
* format.</p>
|
|
3480
3974
|
* @public
|
|
3481
3975
|
*/
|
|
3482
3976
|
environmentVariables?: Record<string, string>;
|
|
@@ -3598,8 +4092,8 @@ export type SchemaStatus = (typeof SchemaStatus)[keyof typeof SchemaStatus];
|
|
|
3598
4092
|
*/
|
|
3599
4093
|
export interface GetSchemaCreationStatusResponse {
|
|
3600
4094
|
/**
|
|
3601
|
-
* <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When
|
|
3602
|
-
* ACTIVE state, you can add data.</p>
|
|
4095
|
+
* <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When
|
|
4096
|
+
* the schema is in the ACTIVE state, you can add data.</p>
|
|
3603
4097
|
* @public
|
|
3604
4098
|
*/
|
|
3605
4099
|
status?: SchemaStatus;
|
|
@@ -3614,9 +4108,10 @@ export interface GetSchemaCreationStatusResponse {
|
|
|
3614
4108
|
*/
|
|
3615
4109
|
export interface GetSourceApiAssociationRequest {
|
|
3616
4110
|
/**
|
|
3617
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
3618
|
-
* APIs (especially in your account) only require the API ID value or ARN
|
|
3619
|
-
* in other accounts (cross-account use cases)
|
|
4111
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
4112
|
+
* most cases, Merged APIs (especially in your account) only require the API ID value or ARN
|
|
4113
|
+
* of the merged API. However, Merged APIs in other accounts (cross-account use cases)
|
|
4114
|
+
* strictly require the full resource ARN of the merged API.</p>
|
|
3620
4115
|
* @public
|
|
3621
4116
|
*/
|
|
3622
4117
|
mergedApiIdentifier: string | undefined;
|
|
@@ -3676,8 +4171,8 @@ export interface ListApiKeysRequest {
|
|
|
3676
4171
|
*/
|
|
3677
4172
|
apiId: string | undefined;
|
|
3678
4173
|
/**
|
|
3679
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3680
|
-
* next set of items in the list.</p>
|
|
4174
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4175
|
+
* use to return the next set of items in the list.</p>
|
|
3681
4176
|
* @public
|
|
3682
4177
|
*/
|
|
3683
4178
|
nextToken?: string;
|
|
@@ -3697,8 +4192,77 @@ export interface ListApiKeysResponse {
|
|
|
3697
4192
|
*/
|
|
3698
4193
|
apiKeys?: ApiKey[];
|
|
3699
4194
|
/**
|
|
3700
|
-
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
3701
|
-
* list.</p>
|
|
4195
|
+
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
4196
|
+
* items in the list.</p>
|
|
4197
|
+
* @public
|
|
4198
|
+
*/
|
|
4199
|
+
nextToken?: string;
|
|
4200
|
+
}
|
|
4201
|
+
/**
|
|
4202
|
+
* @public
|
|
4203
|
+
*/
|
|
4204
|
+
export interface ListApisRequest {
|
|
4205
|
+
/**
|
|
4206
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4207
|
+
* use to return the next set of items in the list.</p>
|
|
4208
|
+
* @public
|
|
4209
|
+
*/
|
|
4210
|
+
nextToken?: string;
|
|
4211
|
+
/**
|
|
4212
|
+
* <p>The maximum number of results that you want the request to return.</p>
|
|
4213
|
+
* @public
|
|
4214
|
+
*/
|
|
4215
|
+
maxResults?: number;
|
|
4216
|
+
}
|
|
4217
|
+
/**
|
|
4218
|
+
* @public
|
|
4219
|
+
*/
|
|
4220
|
+
export interface ListApisResponse {
|
|
4221
|
+
/**
|
|
4222
|
+
* <p>The <code>Api</code> objects.</p>
|
|
4223
|
+
* @public
|
|
4224
|
+
*/
|
|
4225
|
+
apis?: Api[];
|
|
4226
|
+
/**
|
|
4227
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4228
|
+
* use to return the next set of items in the list.</p>
|
|
4229
|
+
* @public
|
|
4230
|
+
*/
|
|
4231
|
+
nextToken?: string;
|
|
4232
|
+
}
|
|
4233
|
+
/**
|
|
4234
|
+
* @public
|
|
4235
|
+
*/
|
|
4236
|
+
export interface ListChannelNamespacesRequest {
|
|
4237
|
+
/**
|
|
4238
|
+
* <p>The <code>Api</code> ID.</p>
|
|
4239
|
+
* @public
|
|
4240
|
+
*/
|
|
4241
|
+
apiId: string | undefined;
|
|
4242
|
+
/**
|
|
4243
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4244
|
+
* use to return the next set of items in the list.</p>
|
|
4245
|
+
* @public
|
|
4246
|
+
*/
|
|
4247
|
+
nextToken?: string;
|
|
4248
|
+
/**
|
|
4249
|
+
* <p>The maximum number of results that you want the request to return.</p>
|
|
4250
|
+
* @public
|
|
4251
|
+
*/
|
|
4252
|
+
maxResults?: number;
|
|
4253
|
+
}
|
|
4254
|
+
/**
|
|
4255
|
+
* @public
|
|
4256
|
+
*/
|
|
4257
|
+
export interface ListChannelNamespacesResponse {
|
|
4258
|
+
/**
|
|
4259
|
+
* <p>The <code>ChannelNamespace</code> objects.</p>
|
|
4260
|
+
* @public
|
|
4261
|
+
*/
|
|
4262
|
+
channelNamespaces?: ChannelNamespace[];
|
|
4263
|
+
/**
|
|
4264
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4265
|
+
* use to return the next set of items in the list.</p>
|
|
3702
4266
|
* @public
|
|
3703
4267
|
*/
|
|
3704
4268
|
nextToken?: string;
|
|
@@ -3713,8 +4277,8 @@ export interface ListDataSourcesRequest {
|
|
|
3713
4277
|
*/
|
|
3714
4278
|
apiId: string | undefined;
|
|
3715
4279
|
/**
|
|
3716
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3717
|
-
* next set of items in the list.</p>
|
|
4280
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4281
|
+
* use to return the next set of items in the list.</p>
|
|
3718
4282
|
* @public
|
|
3719
4283
|
*/
|
|
3720
4284
|
nextToken?: string;
|
|
@@ -3734,8 +4298,8 @@ export interface ListDataSourcesResponse {
|
|
|
3734
4298
|
*/
|
|
3735
4299
|
dataSources?: DataSource[];
|
|
3736
4300
|
/**
|
|
3737
|
-
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
3738
|
-
* list.</p>
|
|
4301
|
+
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
4302
|
+
* items in the list.</p>
|
|
3739
4303
|
* @public
|
|
3740
4304
|
*/
|
|
3741
4305
|
nextToken?: string;
|
|
@@ -3745,8 +4309,8 @@ export interface ListDataSourcesResponse {
|
|
|
3745
4309
|
*/
|
|
3746
4310
|
export interface ListDomainNamesRequest {
|
|
3747
4311
|
/**
|
|
3748
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3749
|
-
* next set of items in the list.</p>
|
|
4312
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4313
|
+
* use to return the next set of items in the list.</p>
|
|
3750
4314
|
* @public
|
|
3751
4315
|
*/
|
|
3752
4316
|
nextToken?: string;
|
|
@@ -3766,8 +4330,8 @@ export interface ListDomainNamesResponse {
|
|
|
3766
4330
|
*/
|
|
3767
4331
|
domainNameConfigs?: DomainNameConfig[];
|
|
3768
4332
|
/**
|
|
3769
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3770
|
-
* next set of items in the list.</p>
|
|
4333
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4334
|
+
* use to return the next set of items in the list.</p>
|
|
3771
4335
|
* @public
|
|
3772
4336
|
*/
|
|
3773
4337
|
nextToken?: string;
|
|
@@ -3782,8 +4346,8 @@ export interface ListFunctionsRequest {
|
|
|
3782
4346
|
*/
|
|
3783
4347
|
apiId: string | undefined;
|
|
3784
4348
|
/**
|
|
3785
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3786
|
-
* next set of items in the list.</p>
|
|
4349
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4350
|
+
* use to return the next set of items in the list.</p>
|
|
3787
4351
|
* @public
|
|
3788
4352
|
*/
|
|
3789
4353
|
nextToken?: string;
|
|
@@ -3803,8 +4367,8 @@ export interface ListFunctionsResponse {
|
|
|
3803
4367
|
*/
|
|
3804
4368
|
functions?: FunctionConfiguration[];
|
|
3805
4369
|
/**
|
|
3806
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3807
|
-
* next set of items in the list.</p>
|
|
4370
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4371
|
+
* use to return the next set of items in the list.</p>
|
|
3808
4372
|
* @public
|
|
3809
4373
|
*/
|
|
3810
4374
|
nextToken?: string;
|
|
@@ -3826,8 +4390,8 @@ export type Ownership = (typeof Ownership)[keyof typeof Ownership];
|
|
|
3826
4390
|
*/
|
|
3827
4391
|
export interface ListGraphqlApisRequest {
|
|
3828
4392
|
/**
|
|
3829
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3830
|
-
* next set of items in the list.</p>
|
|
4393
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4394
|
+
* use to return the next set of items in the list.</p>
|
|
3831
4395
|
* @public
|
|
3832
4396
|
*/
|
|
3833
4397
|
nextToken?: string;
|
|
@@ -3837,8 +4401,8 @@ export interface ListGraphqlApisRequest {
|
|
|
3837
4401
|
*/
|
|
3838
4402
|
maxResults?: number;
|
|
3839
4403
|
/**
|
|
3840
|
-
* <p>The value that indicates whether the GraphQL API is a standard API
|
|
3841
|
-
*
|
|
4404
|
+
* <p>The value that indicates whether the GraphQL API is a standard API
|
|
4405
|
+
* (<code>GRAPHQL</code>) or merged API (<code>MERGED</code>).</p>
|
|
3842
4406
|
* @public
|
|
3843
4407
|
*/
|
|
3844
4408
|
apiType?: GraphQLApiType;
|
|
@@ -3858,8 +4422,8 @@ export interface ListGraphqlApisResponse {
|
|
|
3858
4422
|
*/
|
|
3859
4423
|
graphqlApis?: GraphqlApi[];
|
|
3860
4424
|
/**
|
|
3861
|
-
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
3862
|
-
* list.</p>
|
|
4425
|
+
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
4426
|
+
* items in the list.</p>
|
|
3863
4427
|
* @public
|
|
3864
4428
|
*/
|
|
3865
4429
|
nextToken?: string;
|
|
@@ -3879,8 +4443,8 @@ export interface ListResolversRequest {
|
|
|
3879
4443
|
*/
|
|
3880
4444
|
typeName: string | undefined;
|
|
3881
4445
|
/**
|
|
3882
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3883
|
-
* next set of items in the list.</p>
|
|
4446
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4447
|
+
* use to return the next set of items in the list.</p>
|
|
3884
4448
|
* @public
|
|
3885
4449
|
*/
|
|
3886
4450
|
nextToken?: string;
|
|
@@ -3900,8 +4464,8 @@ export interface ListResolversResponse {
|
|
|
3900
4464
|
*/
|
|
3901
4465
|
resolvers?: Resolver[];
|
|
3902
4466
|
/**
|
|
3903
|
-
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
3904
|
-
* list.</p>
|
|
4467
|
+
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
4468
|
+
* items in the list.</p>
|
|
3905
4469
|
* @public
|
|
3906
4470
|
*/
|
|
3907
4471
|
nextToken?: string;
|
|
@@ -3921,8 +4485,8 @@ export interface ListResolversByFunctionRequest {
|
|
|
3921
4485
|
*/
|
|
3922
4486
|
functionId: string | undefined;
|
|
3923
4487
|
/**
|
|
3924
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3925
|
-
* next set of items in the list.</p>
|
|
4488
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4489
|
+
* use to return the next set of items in the list.</p>
|
|
3926
4490
|
* @public
|
|
3927
4491
|
*/
|
|
3928
4492
|
nextToken?: string;
|
|
@@ -3957,8 +4521,8 @@ export interface ListSourceApiAssociationsRequest {
|
|
|
3957
4521
|
*/
|
|
3958
4522
|
apiId: string | undefined;
|
|
3959
4523
|
/**
|
|
3960
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3961
|
-
* next set of items in the list.</p>
|
|
4524
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4525
|
+
* use to return the next set of items in the list.</p>
|
|
3962
4526
|
* @public
|
|
3963
4527
|
*/
|
|
3964
4528
|
nextToken?: string;
|
|
@@ -4019,8 +4583,8 @@ export interface ListSourceApiAssociationsResponse {
|
|
|
4019
4583
|
*/
|
|
4020
4584
|
sourceApiAssociationSummaries?: SourceApiAssociationSummary[];
|
|
4021
4585
|
/**
|
|
4022
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4023
|
-
* next set of items in the list.</p>
|
|
4586
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4587
|
+
* use to return the next set of items in the list.</p>
|
|
4024
4588
|
* @public
|
|
4025
4589
|
*/
|
|
4026
4590
|
nextToken?: string;
|
|
@@ -4060,8 +4624,8 @@ export interface ListTypesRequest {
|
|
|
4060
4624
|
*/
|
|
4061
4625
|
format: TypeDefinitionFormat | undefined;
|
|
4062
4626
|
/**
|
|
4063
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4064
|
-
* next set of items in the list.</p>
|
|
4627
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4628
|
+
* use to return the next set of items in the list.</p>
|
|
4065
4629
|
* @public
|
|
4066
4630
|
*/
|
|
4067
4631
|
nextToken?: string;
|
|
@@ -4081,8 +4645,8 @@ export interface ListTypesResponse {
|
|
|
4081
4645
|
*/
|
|
4082
4646
|
types?: Type[];
|
|
4083
4647
|
/**
|
|
4084
|
-
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
4085
|
-
* list.</p>
|
|
4648
|
+
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
4649
|
+
* items in the list.</p>
|
|
4086
4650
|
* @public
|
|
4087
4651
|
*/
|
|
4088
4652
|
nextToken?: string;
|
|
@@ -4092,9 +4656,10 @@ export interface ListTypesResponse {
|
|
|
4092
4656
|
*/
|
|
4093
4657
|
export interface ListTypesByAssociationRequest {
|
|
4094
4658
|
/**
|
|
4095
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
4096
|
-
* APIs (especially in your account) only require the API ID value or ARN
|
|
4097
|
-
* in other accounts (cross-account use cases)
|
|
4659
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
4660
|
+
* most cases, Merged APIs (especially in your account) only require the API ID value or ARN
|
|
4661
|
+
* of the merged API. However, Merged APIs in other accounts (cross-account use cases)
|
|
4662
|
+
* strictly require the full resource ARN of the merged API.</p>
|
|
4098
4663
|
* @public
|
|
4099
4664
|
*/
|
|
4100
4665
|
mergedApiIdentifier: string | undefined;
|
|
@@ -4109,8 +4674,8 @@ export interface ListTypesByAssociationRequest {
|
|
|
4109
4674
|
*/
|
|
4110
4675
|
format: TypeDefinitionFormat | undefined;
|
|
4111
4676
|
/**
|
|
4112
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4113
|
-
* next set of items in the list.</p>
|
|
4677
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4678
|
+
* use to return the next set of items in the list.</p>
|
|
4114
4679
|
* @public
|
|
4115
4680
|
*/
|
|
4116
4681
|
nextToken?: string;
|
|
@@ -4130,8 +4695,8 @@ export interface ListTypesByAssociationResponse {
|
|
|
4130
4695
|
*/
|
|
4131
4696
|
types?: Type[];
|
|
4132
4697
|
/**
|
|
4133
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4134
|
-
* next set of items in the list.</p>
|
|
4698
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
4699
|
+
* use to return the next set of items in the list.</p>
|
|
4135
4700
|
* @public
|
|
4136
4701
|
*/
|
|
4137
4702
|
nextToken?: string;
|
|
@@ -4147,8 +4712,8 @@ export interface PutGraphqlApiEnvironmentVariablesRequest {
|
|
|
4147
4712
|
apiId: string | undefined;
|
|
4148
4713
|
/**
|
|
4149
4714
|
* <p>The list of environmental variables to add to the API.</p>
|
|
4150
|
-
* <p>When creating an environmental variable key-value pair, it must follow the additional
|
|
4151
|
-
* below:</p>
|
|
4715
|
+
* <p>When creating an environmental variable key-value pair, it must follow the additional
|
|
4716
|
+
* constraints below:</p>
|
|
4152
4717
|
* <ul>
|
|
4153
4718
|
* <li>
|
|
4154
4719
|
* <p>Keys must begin with a letter.</p>
|
|
@@ -4157,7 +4722,8 @@ export interface PutGraphqlApiEnvironmentVariablesRequest {
|
|
|
4157
4722
|
* <p>Keys must be at least two characters long.</p>
|
|
4158
4723
|
* </li>
|
|
4159
4724
|
* <li>
|
|
4160
|
-
* <p>Keys can only contain letters, numbers, and the underscore character
|
|
4725
|
+
* <p>Keys can only contain letters, numbers, and the underscore character
|
|
4726
|
+
* (_).</p>
|
|
4161
4727
|
* </li>
|
|
4162
4728
|
* <li>
|
|
4163
4729
|
* <p>Values can be up to 512 characters long.</p>
|
|
@@ -4166,12 +4732,13 @@ export interface PutGraphqlApiEnvironmentVariablesRequest {
|
|
|
4166
4732
|
* <p>You can configure up to 50 key-value pairs in a GraphQL API.</p>
|
|
4167
4733
|
* </li>
|
|
4168
4734
|
* </ul>
|
|
4169
|
-
* <p>You can create a list of environmental variables by adding it to the
|
|
4170
|
-
*
|
|
4171
|
-
*
|
|
4172
|
-
*
|
|
4173
|
-
*
|
|
4174
|
-
*
|
|
4735
|
+
* <p>You can create a list of environmental variables by adding it to the
|
|
4736
|
+
* <code>environmentVariables</code> payload as a list in the format
|
|
4737
|
+
* <code>\{"key1":"value1","key2":"value2", …\}</code>. Note that each call of the
|
|
4738
|
+
* <code>PutGraphqlApiEnvironmentVariables</code> action will result in the overwriting of
|
|
4739
|
+
* the existing environmental variable list of that API. This means the existing environmental
|
|
4740
|
+
* variables will be lost. To avoid this, you must include all existing and new environmental
|
|
4741
|
+
* variables in the list each time you call this action.</p>
|
|
4175
4742
|
* @public
|
|
4176
4743
|
*/
|
|
4177
4744
|
environmentVariables: Record<string, string> | undefined;
|
|
@@ -4181,7 +4748,8 @@ export interface PutGraphqlApiEnvironmentVariablesRequest {
|
|
|
4181
4748
|
*/
|
|
4182
4749
|
export interface PutGraphqlApiEnvironmentVariablesResponse {
|
|
4183
4750
|
/**
|
|
4184
|
-
* <p>The payload containing each environmental variable in the <code>"key" : "value"</code>
|
|
4751
|
+
* <p>The payload containing each environmental variable in the <code>"key" : "value"</code>
|
|
4752
|
+
* format.</p>
|
|
4185
4753
|
* @public
|
|
4186
4754
|
*/
|
|
4187
4755
|
environmentVariables?: Record<string, string>;
|
|
@@ -4197,10 +4765,10 @@ export interface RdsDataApiConfig {
|
|
|
4197
4765
|
*/
|
|
4198
4766
|
resourceArn: string | undefined;
|
|
4199
4767
|
/**
|
|
4200
|
-
* <p>The secret's ARN that was obtained from Secrets Manager. A secret consists of secret
|
|
4201
|
-
* value, plus metadata about the secret. A secret value can be a
|
|
4202
|
-
*
|
|
4203
|
-
* data.</p>
|
|
4768
|
+
* <p>The secret's ARN that was obtained from Secrets Manager. A secret consists of secret
|
|
4769
|
+
* information, the secret value, plus metadata about the secret. A secret value can be a
|
|
4770
|
+
* string or binary. It typically includes the ARN, secret name and description, policies,
|
|
4771
|
+
* tags, encryption key from the Key Management Service, and key rotation data.</p>
|
|
4204
4772
|
* @public
|
|
4205
4773
|
*/
|
|
4206
4774
|
secretArn: string | undefined;
|
|
@@ -4225,23 +4793,24 @@ export interface StartDataSourceIntrospectionRequest {
|
|
|
4225
4793
|
*/
|
|
4226
4794
|
export interface StartDataSourceIntrospectionResponse {
|
|
4227
4795
|
/**
|
|
4228
|
-
* <p>The introspection ID. Each introspection contains a unique ID that can be used to
|
|
4229
|
-
* instrospection record.</p>
|
|
4796
|
+
* <p>The introspection ID. Each introspection contains a unique ID that can be used to
|
|
4797
|
+
* reference the instrospection record.</p>
|
|
4230
4798
|
* @public
|
|
4231
4799
|
*/
|
|
4232
4800
|
introspectionId?: string;
|
|
4233
4801
|
/**
|
|
4234
|
-
* <p>The status of the introspection during creation. By default, when a new instrospection
|
|
4235
|
-
* status will be set to <code>PROCESSING</code>. Once the operation has
|
|
4236
|
-
*
|
|
4237
|
-
*
|
|
4802
|
+
* <p>The status of the introspection during creation. By default, when a new instrospection
|
|
4803
|
+
* has been created, the status will be set to <code>PROCESSING</code>. Once the operation has
|
|
4804
|
+
* been completed, the status will change to <code>SUCCESS</code> or <code>FAILED</code>
|
|
4805
|
+
* depending on how the data was parsed. A <code>FAILED</code> operation will return an error
|
|
4806
|
+
* and its details as an <code>introspectionStatusDetail</code>.</p>
|
|
4238
4807
|
* @public
|
|
4239
4808
|
*/
|
|
4240
4809
|
introspectionStatus?: DataSourceIntrospectionStatus;
|
|
4241
4810
|
/**
|
|
4242
4811
|
* <p>The error detail field. When a <code>FAILED</code>
|
|
4243
|
-
* <code>introspectionStatus</code> is returned, the <code>introspectionStatusDetail</code>
|
|
4244
|
-
* exact error that was generated during the operation.</p>
|
|
4812
|
+
* <code>introspectionStatus</code> is returned, the <code>introspectionStatusDetail</code>
|
|
4813
|
+
* will also return the exact error that was generated during the operation.</p>
|
|
4245
4814
|
* @public
|
|
4246
4815
|
*/
|
|
4247
4816
|
introspectionStatusDetail?: string;
|
|
@@ -4266,8 +4835,8 @@ export interface StartSchemaCreationRequest {
|
|
|
4266
4835
|
*/
|
|
4267
4836
|
export interface StartSchemaCreationResponse {
|
|
4268
4837
|
/**
|
|
4269
|
-
* <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When
|
|
4270
|
-
* ACTIVE state, you can add data.</p>
|
|
4838
|
+
* <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When
|
|
4839
|
+
* the schema is in the ACTIVE state, you can add data.</p>
|
|
4271
4840
|
* @public
|
|
4272
4841
|
*/
|
|
4273
4842
|
status?: SchemaStatus;
|
|
@@ -4282,9 +4851,10 @@ export interface StartSchemaMergeRequest {
|
|
|
4282
4851
|
*/
|
|
4283
4852
|
associationId: string | undefined;
|
|
4284
4853
|
/**
|
|
4285
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
4286
|
-
* APIs (especially in your account) only require the API ID value or ARN
|
|
4287
|
-
* in other accounts (cross-account use cases)
|
|
4854
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
4855
|
+
* most cases, Merged APIs (especially in your account) only require the API ID value or ARN
|
|
4856
|
+
* of the merged API. However, Merged APIs in other accounts (cross-account use cases)
|
|
4857
|
+
* strictly require the full resource ARN of the merged API.</p>
|
|
4288
4858
|
* @public
|
|
4289
4859
|
*/
|
|
4290
4860
|
mergedApiIdentifier: string | undefined;
|
|
@@ -4339,6 +4909,42 @@ export interface UntagResourceRequest {
|
|
|
4339
4909
|
*/
|
|
4340
4910
|
export interface UntagResourceResponse {
|
|
4341
4911
|
}
|
|
4912
|
+
/**
|
|
4913
|
+
* @public
|
|
4914
|
+
*/
|
|
4915
|
+
export interface UpdateApiRequest {
|
|
4916
|
+
/**
|
|
4917
|
+
* <p>The <code>Api</code> ID.</p>
|
|
4918
|
+
* @public
|
|
4919
|
+
*/
|
|
4920
|
+
apiId: string | undefined;
|
|
4921
|
+
/**
|
|
4922
|
+
* <p>The name of the Api.</p>
|
|
4923
|
+
* @public
|
|
4924
|
+
*/
|
|
4925
|
+
name: string | undefined;
|
|
4926
|
+
/**
|
|
4927
|
+
* <p>The owner contact information for the <code>Api</code>.</p>
|
|
4928
|
+
* @public
|
|
4929
|
+
*/
|
|
4930
|
+
ownerContact?: string;
|
|
4931
|
+
/**
|
|
4932
|
+
* <p>The new event configuration. This includes the default authorization configuration for
|
|
4933
|
+
* connecting, publishing, and subscribing to an Event API.</p>
|
|
4934
|
+
* @public
|
|
4935
|
+
*/
|
|
4936
|
+
eventConfig?: EventConfig;
|
|
4937
|
+
}
|
|
4938
|
+
/**
|
|
4939
|
+
* @public
|
|
4940
|
+
*/
|
|
4941
|
+
export interface UpdateApiResponse {
|
|
4942
|
+
/**
|
|
4943
|
+
* <p>The <code>Api</code> object.</p>
|
|
4944
|
+
* @public
|
|
4945
|
+
*/
|
|
4946
|
+
api?: Api;
|
|
4947
|
+
}
|
|
4342
4948
|
/**
|
|
4343
4949
|
* <p>Represents the input of a <code>UpdateApiCache</code> operation.</p>
|
|
4344
4950
|
* @public
|
|
@@ -4360,12 +4966,13 @@ export interface UpdateApiCacheRequest {
|
|
|
4360
4966
|
* <ul>
|
|
4361
4967
|
* <li>
|
|
4362
4968
|
* <p>
|
|
4363
|
-
* <b>FULL_REQUEST_CACHING</b>: All requests are fully
|
|
4969
|
+
* <b>FULL_REQUEST_CACHING</b>: All requests are fully
|
|
4970
|
+
* cached.</p>
|
|
4364
4971
|
* </li>
|
|
4365
4972
|
* <li>
|
|
4366
4973
|
* <p>
|
|
4367
|
-
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers
|
|
4368
|
-
* cached.</p>
|
|
4974
|
+
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers
|
|
4975
|
+
* that you specify are cached.</p>
|
|
4369
4976
|
* </li>
|
|
4370
4977
|
* </ul>
|
|
4371
4978
|
* @public
|
|
@@ -4450,20 +5057,22 @@ export interface UpdateApiCacheRequest {
|
|
|
4450
5057
|
*/
|
|
4451
5058
|
type: ApiCacheType | undefined;
|
|
4452
5059
|
/**
|
|
4453
|
-
* <p>Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics
|
|
5060
|
+
* <p>Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics
|
|
5061
|
+
* include:</p>
|
|
4454
5062
|
* <ul>
|
|
4455
5063
|
* <li>
|
|
4456
|
-
* <p>NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the
|
|
4457
|
-
* the aggregated bandwidth limit. This is useful for diagnosing
|
|
4458
|
-
* configuration.</p>
|
|
5064
|
+
* <p>NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the
|
|
5065
|
+
* throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing
|
|
5066
|
+
* bottlenecks in a cache configuration.</p>
|
|
4459
5067
|
* </li>
|
|
4460
5068
|
* <li>
|
|
4461
|
-
* <p>EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis
|
|
4462
|
-
* useful for diagnosing bottlenecks in a cache
|
|
5069
|
+
* <p>EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis
|
|
5070
|
+
* process. This is useful for diagnosing bottlenecks in a cache
|
|
5071
|
+
* configuration.</p>
|
|
4463
5072
|
* </li>
|
|
4464
5073
|
* </ul>
|
|
4465
5074
|
* <p>Metrics will be recorded by API ID. You can set the value to <code>ENABLED</code> or
|
|
4466
|
-
*
|
|
5075
|
+
* <code>DISABLED</code>.</p>
|
|
4467
5076
|
* @public
|
|
4468
5077
|
*/
|
|
4469
5078
|
healthMetricsConfig?: CacheHealthMetricsConfig;
|
|
@@ -4499,8 +5108,8 @@ export interface UpdateApiKeyRequest {
|
|
|
4499
5108
|
*/
|
|
4500
5109
|
description?: string;
|
|
4501
5110
|
/**
|
|
4502
|
-
* <p>From the update time, the time after which the API key expires. The date is represented
|
|
4503
|
-
* epoch. For more information, see .</p>
|
|
5111
|
+
* <p>From the update time, the time after which the API key expires. The date is represented
|
|
5112
|
+
* as seconds since the epoch. For more information, see .</p>
|
|
4504
5113
|
* @public
|
|
4505
5114
|
*/
|
|
4506
5115
|
expires?: number;
|
|
@@ -4515,6 +5124,49 @@ export interface UpdateApiKeyResponse {
|
|
|
4515
5124
|
*/
|
|
4516
5125
|
apiKey?: ApiKey;
|
|
4517
5126
|
}
|
|
5127
|
+
/**
|
|
5128
|
+
* @public
|
|
5129
|
+
*/
|
|
5130
|
+
export interface UpdateChannelNamespaceRequest {
|
|
5131
|
+
/**
|
|
5132
|
+
* <p>The <code>Api</code> ID.</p>
|
|
5133
|
+
* @public
|
|
5134
|
+
*/
|
|
5135
|
+
apiId: string | undefined;
|
|
5136
|
+
/**
|
|
5137
|
+
* <p>The name of the <code>ChannelNamespace</code>.</p>
|
|
5138
|
+
* @public
|
|
5139
|
+
*/
|
|
5140
|
+
name: string | undefined;
|
|
5141
|
+
/**
|
|
5142
|
+
* <p>The authorization mode to use for subscribing to messages on the channel namespace. This
|
|
5143
|
+
* configuration overrides the default <code>Api</code> authorization configuration.</p>
|
|
5144
|
+
* @public
|
|
5145
|
+
*/
|
|
5146
|
+
subscribeAuthModes?: AuthMode[];
|
|
5147
|
+
/**
|
|
5148
|
+
* <p>The authorization mode to use for publishing messages on the channel namespace. This
|
|
5149
|
+
* configuration overrides the default <code>Api</code> authorization configuration.</p>
|
|
5150
|
+
* @public
|
|
5151
|
+
*/
|
|
5152
|
+
publishAuthModes?: AuthMode[];
|
|
5153
|
+
/**
|
|
5154
|
+
* <p>The event handler functions that run custom business logic to process published events
|
|
5155
|
+
* and subscribe requests.</p>
|
|
5156
|
+
* @public
|
|
5157
|
+
*/
|
|
5158
|
+
codeHandlers?: string;
|
|
5159
|
+
}
|
|
5160
|
+
/**
|
|
5161
|
+
* @public
|
|
5162
|
+
*/
|
|
5163
|
+
export interface UpdateChannelNamespaceResponse {
|
|
5164
|
+
/**
|
|
5165
|
+
* <p>The <code>ChannelNamespace</code> object.</p>
|
|
5166
|
+
* @public
|
|
5167
|
+
*/
|
|
5168
|
+
channelNamespace?: ChannelNamespace;
|
|
5169
|
+
}
|
|
4518
5170
|
/**
|
|
4519
5171
|
* @public
|
|
4520
5172
|
*/
|
|
@@ -4556,8 +5208,8 @@ export interface UpdateDataSourceRequest {
|
|
|
4556
5208
|
lambdaConfig?: LambdaDataSourceConfig;
|
|
4557
5209
|
/**
|
|
4558
5210
|
* <p>The new OpenSearch configuration.</p>
|
|
4559
|
-
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This
|
|
4560
|
-
* deprecated. Instead, use <a>UpdateDataSourceRequest$openSearchServiceConfig</a> to update an OpenSearch data source.</p>
|
|
5211
|
+
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This
|
|
5212
|
+
* configuration is deprecated. Instead, use <a>UpdateDataSourceRequest$openSearchServiceConfig</a> to update an OpenSearch data source.</p>
|
|
4561
5213
|
* @public
|
|
4562
5214
|
*/
|
|
4563
5215
|
elasticsearchConfig?: ElasticsearchDataSourceConfig;
|
|
@@ -4583,10 +5235,11 @@ export interface UpdateDataSourceRequest {
|
|
|
4583
5235
|
eventBridgeConfig?: EventBridgeDataSourceConfig;
|
|
4584
5236
|
/**
|
|
4585
5237
|
* <p>Enables or disables enhanced data source metrics for specified data sources. Note that
|
|
4586
|
-
* <code>metricsConfig</code> won't be used unless the
|
|
4587
|
-
*
|
|
4588
|
-
* <code>
|
|
4589
|
-
*
|
|
5238
|
+
* <code>metricsConfig</code> won't be used unless the
|
|
5239
|
+
* <code>dataSourceLevelMetricsBehavior</code> value is set to
|
|
5240
|
+
* <code>PER_DATA_SOURCE_METRICS</code>. If the <code>dataSourceLevelMetricsBehavior</code>
|
|
5241
|
+
* is set to <code>FULL_REQUEST_DATA_SOURCE_METRICS</code> instead, <code>metricsConfig</code>
|
|
5242
|
+
* will be ignored. However, you can still set its value.</p>
|
|
4590
5243
|
* <p>
|
|
4591
5244
|
* <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
4592
5245
|
* @public
|
|
@@ -4659,8 +5312,8 @@ export interface UpdateFunctionRequest {
|
|
|
4659
5312
|
*/
|
|
4660
5313
|
dataSourceName: string | undefined;
|
|
4661
5314
|
/**
|
|
4662
|
-
* <p>The <code>Function</code> request mapping template. Functions support only the
|
|
4663
|
-
* request mapping template.</p>
|
|
5315
|
+
* <p>The <code>Function</code> request mapping template. Functions support only the
|
|
5316
|
+
* 2018-05-29 version of the request mapping template.</p>
|
|
4664
5317
|
* @public
|
|
4665
5318
|
*/
|
|
4666
5319
|
requestMappingTemplate?: string;
|
|
@@ -4670,15 +5323,16 @@ export interface UpdateFunctionRequest {
|
|
|
4670
5323
|
*/
|
|
4671
5324
|
responseMappingTemplate?: string;
|
|
4672
5325
|
/**
|
|
4673
|
-
* <p>The <code>version</code> of the request mapping template. Currently, the supported value
|
|
4674
|
-
* that when using VTL and mapping templates, the
|
|
5326
|
+
* <p>The <code>version</code> of the request mapping template. Currently, the supported value
|
|
5327
|
+
* is 2018-05-29. Note that when using VTL and mapping templates, the
|
|
5328
|
+
* <code>functionVersion</code> is required.</p>
|
|
4675
5329
|
* @public
|
|
4676
5330
|
*/
|
|
4677
5331
|
functionVersion?: string;
|
|
4678
5332
|
/**
|
|
4679
5333
|
* <p>Describes a Sync configuration for a resolver.</p>
|
|
4680
|
-
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
4681
|
-
* invoked.</p>
|
|
5334
|
+
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
5335
|
+
* resolver is invoked.</p>
|
|
4682
5336
|
* @public
|
|
4683
5337
|
*/
|
|
4684
5338
|
syncConfig?: SyncConfig;
|
|
@@ -4688,15 +5342,15 @@ export interface UpdateFunctionRequest {
|
|
|
4688
5342
|
*/
|
|
4689
5343
|
maxBatchSize?: number;
|
|
4690
5344
|
/**
|
|
4691
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
4692
|
-
*
|
|
4693
|
-
* also be specified.</p>
|
|
5345
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
|
|
5346
|
+
* that if a runtime is specified, code must also be specified.</p>
|
|
4694
5347
|
* @public
|
|
4695
5348
|
*/
|
|
4696
5349
|
runtime?: AppSyncRuntime;
|
|
4697
5350
|
/**
|
|
4698
|
-
* <p>The <code>function</code> code that contains the request and response functions. When
|
|
4699
|
-
*
|
|
5351
|
+
* <p>The <code>function</code> code that contains the request and response functions. When
|
|
5352
|
+
* code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
|
|
5353
|
+
* <code>APPSYNC_JS</code>.</p>
|
|
4700
5354
|
* @public
|
|
4701
5355
|
*/
|
|
4702
5356
|
code?: string;
|
|
@@ -4734,9 +5388,10 @@ export interface UpdateGraphqlApiRequest {
|
|
|
4734
5388
|
* <p>The new authentication type for the <code>GraphqlApi</code> object.</p>
|
|
4735
5389
|
* @public
|
|
4736
5390
|
*/
|
|
4737
|
-
authenticationType
|
|
5391
|
+
authenticationType?: AuthenticationType;
|
|
4738
5392
|
/**
|
|
4739
|
-
* <p>The new Amazon Cognito user pool configuration for the <code>~GraphqlApi</code>
|
|
5393
|
+
* <p>The new Amazon Cognito user pool configuration for the <code>~GraphqlApi</code>
|
|
5394
|
+
* object.</p>
|
|
4740
5395
|
* @public
|
|
4741
5396
|
*/
|
|
4742
5397
|
userPoolConfig?: UserPoolConfig;
|
|
@@ -4746,12 +5401,14 @@ export interface UpdateGraphqlApiRequest {
|
|
|
4746
5401
|
*/
|
|
4747
5402
|
openIDConnectConfig?: OpenIDConnectConfig;
|
|
4748
5403
|
/**
|
|
4749
|
-
* <p>A list of additional authentication providers for the <code>GraphqlApi</code>
|
|
5404
|
+
* <p>A list of additional authentication providers for the <code>GraphqlApi</code>
|
|
5405
|
+
* API.</p>
|
|
4750
5406
|
* @public
|
|
4751
5407
|
*/
|
|
4752
5408
|
additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
|
|
4753
5409
|
/**
|
|
4754
|
-
* <p>A flag indicating whether to use X-Ray tracing for the
|
|
5410
|
+
* <p>A flag indicating whether to use X-Ray tracing for the
|
|
5411
|
+
* <code>GraphqlApi</code>.</p>
|
|
4755
5412
|
* @public
|
|
4756
5413
|
*/
|
|
4757
5414
|
xrayEnabled?: boolean;
|
|
@@ -4761,9 +5418,10 @@ export interface UpdateGraphqlApiRequest {
|
|
|
4761
5418
|
*/
|
|
4762
5419
|
lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
|
|
4763
5420
|
/**
|
|
4764
|
-
* <p>The Identity and Access Management service role ARN for a merged API. The AppSync
|
|
4765
|
-
* on behalf of the Merged API to validate access to source APIs at
|
|
4766
|
-
*
|
|
5421
|
+
* <p>The Identity and Access Management service role ARN for a merged API. The AppSync
|
|
5422
|
+
* service assumes this role on behalf of the Merged API to validate access to source APIs at
|
|
5423
|
+
* runtime and to prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with
|
|
5424
|
+
* the source API changes automatically.</p>
|
|
4767
5425
|
* @public
|
|
4768
5426
|
*/
|
|
4769
5427
|
mergedApiExecutionRoleArn?: string;
|
|
@@ -4774,30 +5432,32 @@ export interface UpdateGraphqlApiRequest {
|
|
|
4774
5432
|
*/
|
|
4775
5433
|
ownerContact?: string;
|
|
4776
5434
|
/**
|
|
4777
|
-
* <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable
|
|
4778
|
-
*
|
|
4779
|
-
*
|
|
4780
|
-
* field is
|
|
4781
|
-
*
|
|
4782
|
-
*
|
|
5435
|
+
* <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable
|
|
5436
|
+
* (<code>DISABLED</code>) introspection. If no value is provided, the introspection
|
|
5437
|
+
* configuration will be set to <code>ENABLED</code> by default. This field will produce an
|
|
5438
|
+
* error if the operation attempts to use the introspection feature while this field is
|
|
5439
|
+
* disabled.</p>
|
|
5440
|
+
* <p>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL introspection</a>.</p>
|
|
4783
5441
|
* @public
|
|
4784
5442
|
*/
|
|
4785
5443
|
introspectionConfig?: GraphQLApiIntrospectionConfig;
|
|
4786
5444
|
/**
|
|
4787
|
-
* <p>The maximum depth a query can have in a single request. Depth refers to the amount of
|
|
4788
|
-
* in the body of query. The default value is <code>0</code> (or
|
|
4789
|
-
* limit. If you set a limit, it can be between
|
|
4790
|
-
*
|
|
4791
|
-
*
|
|
4792
|
-
*
|
|
5445
|
+
* <p>The maximum depth a query can have in a single request. Depth refers to the amount of
|
|
5446
|
+
* nested levels allowed in the body of query. The default value is <code>0</code> (or
|
|
5447
|
+
* unspecified), which indicates there's no depth limit. If you set a limit, it can be between
|
|
5448
|
+
* <code>1</code> and <code>75</code> nested levels. This field will produce a limit error
|
|
5449
|
+
* if the operation falls out of bounds.</p>
|
|
5450
|
+
* <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field
|
|
5451
|
+
* produces an error, the error will be thrown upwards to the first nullable field
|
|
5452
|
+
* available.</p>
|
|
4793
5453
|
* @public
|
|
4794
5454
|
*/
|
|
4795
5455
|
queryDepthLimit?: number;
|
|
4796
5456
|
/**
|
|
4797
|
-
* <p>The maximum number of resolvers that can be invoked in a single request. The default
|
|
4798
|
-
* (or unspecified), which will set the limit to <code>10000</code>.
|
|
4799
|
-
* between <code>1</code> and <code>10000</code>. This
|
|
4800
|
-
* of bounds.</p>
|
|
5457
|
+
* <p>The maximum number of resolvers that can be invoked in a single request. The default
|
|
5458
|
+
* value is <code>0</code> (or unspecified), which will set the limit to <code>10000</code>.
|
|
5459
|
+
* When specified, the limit value can be between <code>1</code> and <code>10000</code>. This
|
|
5460
|
+
* field will produce a limit error if the operation falls out of bounds.</p>
|
|
4801
5461
|
* @public
|
|
4802
5462
|
*/
|
|
4803
5463
|
resolverCountLimit?: number;
|
|
@@ -4843,10 +5503,12 @@ export interface UpdateResolverRequest {
|
|
|
4843
5503
|
dataSourceName?: string;
|
|
4844
5504
|
/**
|
|
4845
5505
|
* <p>The new request mapping template.</p>
|
|
4846
|
-
* <p>A resolver uses a request mapping template to convert a GraphQL expression into a format
|
|
4847
|
-
* can understand. Mapping templates are written in Apache Velocity
|
|
4848
|
-
*
|
|
4849
|
-
*
|
|
5506
|
+
* <p>A resolver uses a request mapping template to convert a GraphQL expression into a format
|
|
5507
|
+
* that a data source can understand. Mapping templates are written in Apache Velocity
|
|
5508
|
+
* Template Language (VTL).</p>
|
|
5509
|
+
* <p>VTL request mapping templates are optional when using an Lambda data
|
|
5510
|
+
* source. For all other data sources, VTL request and response mapping templates are
|
|
5511
|
+
* required.</p>
|
|
4850
5512
|
* @public
|
|
4851
5513
|
*/
|
|
4852
5514
|
requestMappingTemplate?: string;
|
|
@@ -4860,14 +5522,16 @@ export interface UpdateResolverRequest {
|
|
|
4860
5522
|
* <ul>
|
|
4861
5523
|
* <li>
|
|
4862
5524
|
* <p>
|
|
4863
|
-
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is
|
|
4864
|
-
* resolver type. You can use a UNIT resolver to run a GraphQL query against
|
|
5525
|
+
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is
|
|
5526
|
+
* the default resolver type. You can use a UNIT resolver to run a GraphQL query against
|
|
5527
|
+
* a single data source.</p>
|
|
4865
5528
|
* </li>
|
|
4866
5529
|
* <li>
|
|
4867
5530
|
* <p>
|
|
4868
|
-
* <b>PIPELINE</b>: A PIPELINE resolver type. You can
|
|
4869
|
-
* resolver to invoke a series of <code>Function</code> objects in a
|
|
4870
|
-
* resolver to run a GraphQL query against
|
|
5531
|
+
* <b>PIPELINE</b>: A PIPELINE resolver type. You can
|
|
5532
|
+
* use a PIPELINE resolver to invoke a series of <code>Function</code> objects in a
|
|
5533
|
+
* serial manner. You can use a pipeline resolver to run a GraphQL query against
|
|
5534
|
+
* multiple data sources.</p>
|
|
4871
5535
|
* </li>
|
|
4872
5536
|
* </ul>
|
|
4873
5537
|
* @public
|
|
@@ -4894,24 +5558,25 @@ export interface UpdateResolverRequest {
|
|
|
4894
5558
|
*/
|
|
4895
5559
|
maxBatchSize?: number;
|
|
4896
5560
|
/**
|
|
4897
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
4898
|
-
*
|
|
4899
|
-
* also be specified.</p>
|
|
5561
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note
|
|
5562
|
+
* that if a runtime is specified, code must also be specified.</p>
|
|
4900
5563
|
* @public
|
|
4901
5564
|
*/
|
|
4902
5565
|
runtime?: AppSyncRuntime;
|
|
4903
5566
|
/**
|
|
4904
|
-
* <p>The <code>resolver</code> code that contains the request and response functions. When
|
|
4905
|
-
*
|
|
5567
|
+
* <p>The <code>resolver</code> code that contains the request and response functions. When
|
|
5568
|
+
* code is used, the <code>runtime</code> is required. The <code>runtime</code> value must be
|
|
5569
|
+
* <code>APPSYNC_JS</code>.</p>
|
|
4906
5570
|
* @public
|
|
4907
5571
|
*/
|
|
4908
5572
|
code?: string;
|
|
4909
5573
|
/**
|
|
4910
|
-
* <p>Enables or disables enhanced resolver metrics for specified resolvers. Note that
|
|
4911
|
-
*
|
|
4912
|
-
*
|
|
4913
|
-
*
|
|
4914
|
-
*
|
|
5574
|
+
* <p>Enables or disables enhanced resolver metrics for specified resolvers. Note that
|
|
5575
|
+
* <code>metricsConfig</code> won't be used unless the
|
|
5576
|
+
* <code>resolverLevelMetricsBehavior</code> value is set to
|
|
5577
|
+
* <code>PER_RESOLVER_METRICS</code>. If the <code>resolverLevelMetricsBehavior</code> is
|
|
5578
|
+
* set to <code>FULL_REQUEST_RESOLVER_METRICS</code> instead, <code>metricsConfig</code> will
|
|
5579
|
+
* be ignored. However, you can still set its value.</p>
|
|
4915
5580
|
* <p>
|
|
4916
5581
|
* <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
|
|
4917
5582
|
* @public
|
|
@@ -4938,9 +5603,10 @@ export interface UpdateSourceApiAssociationRequest {
|
|
|
4938
5603
|
*/
|
|
4939
5604
|
associationId: string | undefined;
|
|
4940
5605
|
/**
|
|
4941
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
4942
|
-
* APIs (especially in your account) only require the API ID value or ARN
|
|
4943
|
-
* in other accounts (cross-account use cases)
|
|
5606
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In
|
|
5607
|
+
* most cases, Merged APIs (especially in your account) only require the API ID value or ARN
|
|
5608
|
+
* of the merged API. However, Merged APIs in other accounts (cross-account use cases)
|
|
5609
|
+
* strictly require the full resource ARN of the merged API.</p>
|
|
4944
5610
|
* @public
|
|
4945
5611
|
*/
|
|
4946
5612
|
mergedApiIdentifier: string | undefined;
|
|
@@ -5006,17 +5672,20 @@ export interface UpdateTypeResponse {
|
|
|
5006
5672
|
*/
|
|
5007
5673
|
export interface DataSourceIntrospectionModelFieldType {
|
|
5008
5674
|
/**
|
|
5009
|
-
* <p>Specifies the classification of data. For example, this could be set to values like
|
|
5010
|
-
* <code>NonNull</code> to indicate a fundamental property of the
|
|
5675
|
+
* <p>Specifies the classification of data. For example, this could be set to values like
|
|
5676
|
+
* <code>Scalar</code> or <code>NonNull</code> to indicate a fundamental property of the
|
|
5677
|
+
* field.</p>
|
|
5011
5678
|
* <p>Valid values include:</p>
|
|
5012
5679
|
* <ul>
|
|
5013
5680
|
* <li>
|
|
5014
5681
|
* <p>
|
|
5015
|
-
* <code>Scalar</code>: Indicates the value is a primitive type
|
|
5682
|
+
* <code>Scalar</code>: Indicates the value is a primitive type
|
|
5683
|
+
* (scalar).</p>
|
|
5016
5684
|
* </li>
|
|
5017
5685
|
* <li>
|
|
5018
5686
|
* <p>
|
|
5019
|
-
* <code>NonNull</code>: Indicates the field cannot be
|
|
5687
|
+
* <code>NonNull</code>: Indicates the field cannot be
|
|
5688
|
+
* <code>null</code>.</p>
|
|
5020
5689
|
* </li>
|
|
5021
5690
|
* <li>
|
|
5022
5691
|
* <p>
|
|
@@ -5027,24 +5696,27 @@ export interface DataSourceIntrospectionModelFieldType {
|
|
|
5027
5696
|
*/
|
|
5028
5697
|
kind?: string;
|
|
5029
5698
|
/**
|
|
5030
|
-
* <p>The name of the data type that represents the field. For example, <code>String</code> is
|
|
5031
|
-
*
|
|
5699
|
+
* <p>The name of the data type that represents the field. For example, <code>String</code> is
|
|
5700
|
+
* a valid <code>name</code> value.</p>
|
|
5032
5701
|
* @public
|
|
5033
5702
|
*/
|
|
5034
5703
|
name?: string;
|
|
5035
5704
|
/**
|
|
5036
|
-
* <p>The <code>DataSourceIntrospectionModelFieldType</code> object data. The
|
|
5037
|
-
* <code>
|
|
5038
|
-
*
|
|
5039
|
-
*
|
|
5040
|
-
*
|
|
5041
|
-
*
|
|
5705
|
+
* <p>The <code>DataSourceIntrospectionModelFieldType</code> object data. The
|
|
5706
|
+
* <code>type</code> is only present if
|
|
5707
|
+
* <code>DataSourceIntrospectionModelFieldType.kind</code> is set to <code>NonNull</code>
|
|
5708
|
+
* or <code>List</code>. </p>
|
|
5709
|
+
* <p>The <code>type</code> typically contains its own <code>kind</code> and <code>name</code>
|
|
5710
|
+
* fields to represent the actual type data. For instance, <code>type</code> could contain a
|
|
5711
|
+
* <code>kind</code> value of <code>Scalar</code> with a <code>name</code> value of
|
|
5712
|
+
* <code>String</code>. The values <code>Scalar</code> and <code>String</code> will be
|
|
5713
|
+
* collectively stored in the <code>values</code> field.</p>
|
|
5042
5714
|
* @public
|
|
5043
5715
|
*/
|
|
5044
5716
|
type?: DataSourceIntrospectionModelFieldType;
|
|
5045
5717
|
/**
|
|
5046
|
-
* <p>The values of the <code>type</code> field. This field represents the AppSync data type
|
|
5047
|
-
* introspected field.</p>
|
|
5718
|
+
* <p>The values of the <code>type</code> field. This field represents the AppSync data type
|
|
5719
|
+
* equivalent of the introspected field.</p>
|
|
5048
5720
|
* @public
|
|
5049
5721
|
*/
|
|
5050
5722
|
values?: string[];
|
|
@@ -5076,7 +5748,8 @@ export interface DataSourceIntrospectionModelField {
|
|
|
5076
5748
|
*/
|
|
5077
5749
|
export interface DataSourceIntrospectionModel {
|
|
5078
5750
|
/**
|
|
5079
|
-
* <p>The name of the model. For example, this could be the name of a single table in a
|
|
5751
|
+
* <p>The name of the model. For example, this could be the name of a single table in a
|
|
5752
|
+
* database.</p>
|
|
5080
5753
|
* @public
|
|
5081
5754
|
*/
|
|
5082
5755
|
name?: string;
|
|
@@ -5086,7 +5759,8 @@ export interface DataSourceIntrospectionModel {
|
|
|
5086
5759
|
*/
|
|
5087
5760
|
fields?: DataSourceIntrospectionModelField[];
|
|
5088
5761
|
/**
|
|
5089
|
-
* <p>The primary key stored as a <code>DataSourceIntrospectionModelIndex</code>
|
|
5762
|
+
* <p>The primary key stored as a <code>DataSourceIntrospectionModelIndex</code>
|
|
5763
|
+
* object.</p>
|
|
5090
5764
|
* @public
|
|
5091
5765
|
*/
|
|
5092
5766
|
primaryKey?: DataSourceIntrospectionModelIndex;
|
|
@@ -5096,15 +5770,16 @@ export interface DataSourceIntrospectionModel {
|
|
|
5096
5770
|
*/
|
|
5097
5771
|
indexes?: DataSourceIntrospectionModelIndex[];
|
|
5098
5772
|
/**
|
|
5099
|
-
* <p>Contains the output of the SDL that was generated from the introspected types. This is
|
|
5100
|
-
*
|
|
5773
|
+
* <p>Contains the output of the SDL that was generated from the introspected types. This is
|
|
5774
|
+
* controlled by the <code>includeModelsSDL</code> parameter of the
|
|
5775
|
+
* <code>GetDataSourceIntrospection</code> operation.</p>
|
|
5101
5776
|
* @public
|
|
5102
5777
|
*/
|
|
5103
5778
|
sdl?: string;
|
|
5104
5779
|
}
|
|
5105
5780
|
/**
|
|
5106
|
-
* <p>Represents the output of a <code>DataSourceIntrospectionResult</code>. This is the
|
|
5107
|
-
*
|
|
5781
|
+
* <p>Represents the output of a <code>DataSourceIntrospectionResult</code>. This is the
|
|
5782
|
+
* populated result of a <code>GetDataSourceIntrospection</code> operation.</p>
|
|
5108
5783
|
* @public
|
|
5109
5784
|
*/
|
|
5110
5785
|
export interface DataSourceIntrospectionResult {
|
|
@@ -5114,8 +5789,9 @@ export interface DataSourceIntrospectionResult {
|
|
|
5114
5789
|
*/
|
|
5115
5790
|
models?: DataSourceIntrospectionModel[];
|
|
5116
5791
|
/**
|
|
5117
|
-
* <p>Determines the number of types to be returned in a single response before paginating.
|
|
5118
|
-
* typically taken from <code>nextToken</code> value from the previous
|
|
5792
|
+
* <p>Determines the number of types to be returned in a single response before paginating.
|
|
5793
|
+
* This value is typically taken from <code>nextToken</code> value from the previous
|
|
5794
|
+
* response.</p>
|
|
5119
5795
|
* @public
|
|
5120
5796
|
*/
|
|
5121
5797
|
nextToken?: string;
|
|
@@ -5125,24 +5801,24 @@ export interface DataSourceIntrospectionResult {
|
|
|
5125
5801
|
*/
|
|
5126
5802
|
export interface GetDataSourceIntrospectionResponse {
|
|
5127
5803
|
/**
|
|
5128
|
-
* <p>The introspection ID. Each introspection contains a unique ID that can be used to
|
|
5129
|
-
* instrospection record.</p>
|
|
5804
|
+
* <p>The introspection ID. Each introspection contains a unique ID that can be used to
|
|
5805
|
+
* reference the instrospection record.</p>
|
|
5130
5806
|
* @public
|
|
5131
5807
|
*/
|
|
5132
5808
|
introspectionId?: string;
|
|
5133
5809
|
/**
|
|
5134
|
-
* <p>The status of the introspection during retrieval. By default, when a new instrospection
|
|
5135
|
-
* the status will be set to <code>PROCESSING</code>. Once the operation
|
|
5136
|
-
* change to <code>SUCCESS</code> or <code>FAILED</code>
|
|
5137
|
-
*
|
|
5138
|
-
*
|
|
5810
|
+
* <p>The status of the introspection during retrieval. By default, when a new instrospection
|
|
5811
|
+
* is being retrieved, the status will be set to <code>PROCESSING</code>. Once the operation
|
|
5812
|
+
* has been completed, the status will change to <code>SUCCESS</code> or <code>FAILED</code>
|
|
5813
|
+
* depending on how the data was parsed. A <code>FAILED</code> operation will return an error
|
|
5814
|
+
* and its details as an <code>introspectionStatusDetail</code>.</p>
|
|
5139
5815
|
* @public
|
|
5140
5816
|
*/
|
|
5141
5817
|
introspectionStatus?: DataSourceIntrospectionStatus;
|
|
5142
5818
|
/**
|
|
5143
5819
|
* <p>The error detail field. When a <code>FAILED</code>
|
|
5144
|
-
* <code>introspectionStatus</code> is returned, the <code>introspectionStatusDetail</code>
|
|
5145
|
-
* exact error that was generated during the operation.</p>
|
|
5820
|
+
* <code>introspectionStatus</code> is returned, the <code>introspectionStatusDetail</code>
|
|
5821
|
+
* will also return the exact error that was generated during the operation.</p>
|
|
5146
5822
|
* @public
|
|
5147
5823
|
*/
|
|
5148
5824
|
introspectionStatusDetail?: string;
|