AppSync provides API actions for creating and interacting with data sources using GraphQL -from your application.
+AppSync provides API actions for creating and interacting with data +sources using GraphQL from your application.
## Installing -To install the this package, simply type add or install @aws-sdk/client-appsync +To install this package, simply type add or install @aws-sdk/client-appsync using your favorite package manager: - `npm install @aws-sdk/client-appsync` @@ -24,16 +24,16 @@ using your favorite package manager: The AWS SDK is modulized by clients and commands. To send a request, you only need to import the `AppSyncClient` and -the commands you need, for example `ListApiKeysCommand`: +the commands you need, for example `ListApisCommand`: ```js // ES5 example -const { AppSyncClient, ListApiKeysCommand } = require("@aws-sdk/client-appsync"); +const { AppSyncClient, ListApisCommand } = require("@aws-sdk/client-appsync"); ``` ```ts // ES6+ example -import { AppSyncClient, ListApiKeysCommand } from "@aws-sdk/client-appsync"; +import { AppSyncClient, ListApisCommand } from "@aws-sdk/client-appsync"; ``` ### Usage @@ -52,7 +52,7 @@ const client = new AppSyncClient({ region: "REGION" }); const params = { /** input parameters */ }; -const command = new ListApiKeysCommand(params); +const command = new ListApisCommand(params); ``` #### Async/await @@ -131,7 +131,7 @@ const client = new AWS.AppSync({ region: "REGION" }); // async/await. try { - const data = await client.listApiKeys(params); + const data = await client.listApis(params); // process data. } catch (error) { // error handling. @@ -139,7 +139,7 @@ try { // Promises. client - .listApiKeys(params) + .listApis(params) .then((data) => { // process data. }) @@ -148,7 +148,7 @@ client }); // callbacks. -client.listApiKeys(params, (err, data) => { +client.listApis(params, (err, data) => { // process err and data. }); ``` @@ -227,6 +227,14 @@ AssociateSourceGraphqlApi [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/appsync/command/AssociateSourceGraphqlApiCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-appsync/Interface/AssociateSourceGraphqlApiCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-appsync/Interface/AssociateSourceGraphqlApiCommandOutput/) + +AppSync provides API actions for creating and interacting with data sources using GraphQL - * from your application.
+ *AppSync provides API actions for creating and interacting with data + * sources using GraphQL from your application.
* @public */ export class AppSync extends AppSyncClient implements AppSync {} diff --git a/clients/client-appsync/src/AppSyncClient.ts b/clients/client-appsync/src/AppSyncClient.ts index c07d31289c5d..1fd3157f75f2 100644 --- a/clients/client-appsync/src/AppSyncClient.ts +++ b/clients/client-appsync/src/AppSyncClient.ts @@ -63,7 +63,12 @@ import { AssociateSourceGraphqlApiCommandOutput, } from "./commands/AssociateSourceGraphqlApiCommand"; import { CreateApiCacheCommandInput, CreateApiCacheCommandOutput } from "./commands/CreateApiCacheCommand"; +import { CreateApiCommandInput, CreateApiCommandOutput } from "./commands/CreateApiCommand"; import { CreateApiKeyCommandInput, CreateApiKeyCommandOutput } from "./commands/CreateApiKeyCommand"; +import { + CreateChannelNamespaceCommandInput, + CreateChannelNamespaceCommandOutput, +} from "./commands/CreateChannelNamespaceCommand"; import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "./commands/CreateDataSourceCommand"; import { CreateDomainNameCommandInput, CreateDomainNameCommandOutput } from "./commands/CreateDomainNameCommand"; import { CreateFunctionCommandInput, CreateFunctionCommandOutput } from "./commands/CreateFunctionCommand"; @@ -71,7 +76,12 @@ import { CreateGraphqlApiCommandInput, CreateGraphqlApiCommandOutput } from "./c import { CreateResolverCommandInput, CreateResolverCommandOutput } from "./commands/CreateResolverCommand"; import { CreateTypeCommandInput, CreateTypeCommandOutput } from "./commands/CreateTypeCommand"; import { DeleteApiCacheCommandInput, DeleteApiCacheCommandOutput } from "./commands/DeleteApiCacheCommand"; +import { DeleteApiCommandInput, DeleteApiCommandOutput } from "./commands/DeleteApiCommand"; import { DeleteApiKeyCommandInput, DeleteApiKeyCommandOutput } from "./commands/DeleteApiKeyCommand"; +import { + DeleteChannelNamespaceCommandInput, + DeleteChannelNamespaceCommandOutput, +} from "./commands/DeleteChannelNamespaceCommand"; import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "./commands/DeleteDataSourceCommand"; import { DeleteDomainNameCommandInput, DeleteDomainNameCommandOutput } from "./commands/DeleteDomainNameCommand"; import { DeleteFunctionCommandInput, DeleteFunctionCommandOutput } from "./commands/DeleteFunctionCommand"; @@ -95,6 +105,11 @@ import { import { FlushApiCacheCommandInput, FlushApiCacheCommandOutput } from "./commands/FlushApiCacheCommand"; import { GetApiAssociationCommandInput, GetApiAssociationCommandOutput } from "./commands/GetApiAssociationCommand"; import { GetApiCacheCommandInput, GetApiCacheCommandOutput } from "./commands/GetApiCacheCommand"; +import { GetApiCommandInput, GetApiCommandOutput } from "./commands/GetApiCommand"; +import { + GetChannelNamespaceCommandInput, + GetChannelNamespaceCommandOutput, +} from "./commands/GetChannelNamespaceCommand"; import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "./commands/GetDataSourceCommand"; import { GetDataSourceIntrospectionCommandInput, @@ -122,6 +137,11 @@ import { } from "./commands/GetSourceApiAssociationCommand"; import { GetTypeCommandInput, GetTypeCommandOutput } from "./commands/GetTypeCommand"; import { ListApiKeysCommandInput, ListApiKeysCommandOutput } from "./commands/ListApiKeysCommand"; +import { ListApisCommandInput, ListApisCommandOutput } from "./commands/ListApisCommand"; +import { + ListChannelNamespacesCommandInput, + ListChannelNamespacesCommandOutput, +} from "./commands/ListChannelNamespacesCommand"; import { ListDataSourcesCommandInput, ListDataSourcesCommandOutput } from "./commands/ListDataSourcesCommand"; import { ListDomainNamesCommandInput, ListDomainNamesCommandOutput } from "./commands/ListDomainNamesCommand"; import { ListFunctionsCommandInput, ListFunctionsCommandOutput } from "./commands/ListFunctionsCommand"; @@ -160,7 +180,12 @@ import { StartSchemaMergeCommandInput, StartSchemaMergeCommandOutput } from "./c import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; import { UpdateApiCacheCommandInput, UpdateApiCacheCommandOutput } from "./commands/UpdateApiCacheCommand"; +import { UpdateApiCommandInput, UpdateApiCommandOutput } from "./commands/UpdateApiCommand"; import { UpdateApiKeyCommandInput, UpdateApiKeyCommandOutput } from "./commands/UpdateApiKeyCommand"; +import { + UpdateChannelNamespaceCommandInput, + UpdateChannelNamespaceCommandOutput, +} from "./commands/UpdateChannelNamespaceCommand"; import { UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput } from "./commands/UpdateDataSourceCommand"; import { UpdateDomainNameCommandInput, UpdateDomainNameCommandOutput } from "./commands/UpdateDomainNameCommand"; import { UpdateFunctionCommandInput, UpdateFunctionCommandOutput } from "./commands/UpdateFunctionCommand"; @@ -190,7 +215,9 @@ export type ServiceInputTypes = | AssociateMergedGraphqlApiCommandInput | AssociateSourceGraphqlApiCommandInput | CreateApiCacheCommandInput + | CreateApiCommandInput | CreateApiKeyCommandInput + | CreateChannelNamespaceCommandInput | CreateDataSourceCommandInput | CreateDomainNameCommandInput | CreateFunctionCommandInput @@ -198,7 +225,9 @@ export type ServiceInputTypes = | CreateResolverCommandInput | CreateTypeCommandInput | DeleteApiCacheCommandInput + | DeleteApiCommandInput | DeleteApiKeyCommandInput + | DeleteChannelNamespaceCommandInput | DeleteDataSourceCommandInput | DeleteDomainNameCommandInput | DeleteFunctionCommandInput @@ -213,6 +242,8 @@ export type ServiceInputTypes = | FlushApiCacheCommandInput | GetApiAssociationCommandInput | GetApiCacheCommandInput + | GetApiCommandInput + | GetChannelNamespaceCommandInput | GetDataSourceCommandInput | GetDataSourceIntrospectionCommandInput | GetDomainNameCommandInput @@ -225,6 +256,8 @@ export type ServiceInputTypes = | GetSourceApiAssociationCommandInput | GetTypeCommandInput | ListApiKeysCommandInput + | ListApisCommandInput + | ListChannelNamespacesCommandInput | ListDataSourcesCommandInput | ListDomainNamesCommandInput | ListFunctionsCommandInput @@ -242,7 +275,9 @@ export type ServiceInputTypes = | TagResourceCommandInput | UntagResourceCommandInput | UpdateApiCacheCommandInput + | UpdateApiCommandInput | UpdateApiKeyCommandInput + | UpdateChannelNamespaceCommandInput | UpdateDataSourceCommandInput | UpdateDomainNameCommandInput | UpdateFunctionCommandInput @@ -259,7 +294,9 @@ export type ServiceOutputTypes = | AssociateMergedGraphqlApiCommandOutput | AssociateSourceGraphqlApiCommandOutput | CreateApiCacheCommandOutput + | CreateApiCommandOutput | CreateApiKeyCommandOutput + | CreateChannelNamespaceCommandOutput | CreateDataSourceCommandOutput | CreateDomainNameCommandOutput | CreateFunctionCommandOutput @@ -267,7 +304,9 @@ export type ServiceOutputTypes = | CreateResolverCommandOutput | CreateTypeCommandOutput | DeleteApiCacheCommandOutput + | DeleteApiCommandOutput | DeleteApiKeyCommandOutput + | DeleteChannelNamespaceCommandOutput | DeleteDataSourceCommandOutput | DeleteDomainNameCommandOutput | DeleteFunctionCommandOutput @@ -282,6 +321,8 @@ export type ServiceOutputTypes = | FlushApiCacheCommandOutput | GetApiAssociationCommandOutput | GetApiCacheCommandOutput + | GetApiCommandOutput + | GetChannelNamespaceCommandOutput | GetDataSourceCommandOutput | GetDataSourceIntrospectionCommandOutput | GetDomainNameCommandOutput @@ -294,6 +335,8 @@ export type ServiceOutputTypes = | GetSourceApiAssociationCommandOutput | GetTypeCommandOutput | ListApiKeysCommandOutput + | ListApisCommandOutput + | ListChannelNamespacesCommandOutput | ListDataSourcesCommandOutput | ListDomainNamesCommandOutput | ListFunctionsCommandOutput @@ -311,7 +354,9 @@ export type ServiceOutputTypes = | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateApiCacheCommandOutput + | UpdateApiCommandOutput | UpdateApiKeyCommandOutput + | UpdateChannelNamespaceCommandOutput | UpdateDataSourceCommandOutput | UpdateDomainNameCommandOutput | UpdateFunctionCommandOutput @@ -492,8 +537,8 @@ export type AppSyncClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht export interface AppSyncClientResolvedConfig extends AppSyncClientResolvedConfigType {} /** - *AppSync provides API actions for creating and interacting with data sources using GraphQL - * from your application.
+ *AppSync provides API actions for creating and interacting with data + * sources using GraphQL from your application.
* @public */ export class AppSyncClient extends __Client< diff --git a/clients/client-appsync/src/commands/AssociateApiCommand.ts b/clients/client-appsync/src/commands/AssociateApiCommand.ts index 1be78a37f952..db51cc9a5131 100644 --- a/clients/client-appsync/src/commands/AssociateApiCommand.ts +++ b/clients/client-appsync/src/commands/AssociateApiCommand.ts @@ -62,14 +62,15 @@ export interface AssociateApiCommandOutput extends AssociateApiResponse, __Metad *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link AppSyncServiceException} *Base exception class for all service exceptions from AppSync service.
diff --git a/clients/client-appsync/src/commands/AssociateMergedGraphqlApiCommand.ts b/clients/client-appsync/src/commands/AssociateMergedGraphqlApiCommand.ts index fcb270aa1358..c76637763eda 100644 --- a/clients/client-appsync/src/commands/AssociateMergedGraphqlApiCommand.ts +++ b/clients/client-appsync/src/commands/AssociateMergedGraphqlApiCommand.ts @@ -28,7 +28,8 @@ export interface AssociateMergedGraphqlApiCommandInput extends AssociateMergedGr export interface AssociateMergedGraphqlApiCommandOutput extends AssociateMergedGraphqlApiResponse, __MetadataBearer {} /** - *Creates an association between a Merged API and source API using the source API's identifier.
+ *Creates an association between a Merged API and source API using the source API's + * identifier.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -72,12 +73,12 @@ export interface AssociateMergedGraphqlApiCommandOutput extends AssociateMergedG * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
@@ -86,7 +87,8 @@ export interface AssociateMergedGraphqlApiCommandOutput extends AssociateMergedG *The request exceeded a limit. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/AssociateSourceGraphqlApiCommand.ts b/clients/client-appsync/src/commands/AssociateSourceGraphqlApiCommand.ts index f5fdd01a5540..e6a11f5a6745 100644 --- a/clients/client-appsync/src/commands/AssociateSourceGraphqlApiCommand.ts +++ b/clients/client-appsync/src/commands/AssociateSourceGraphqlApiCommand.ts @@ -28,7 +28,8 @@ export interface AssociateSourceGraphqlApiCommandInput extends AssociateSourceGr export interface AssociateSourceGraphqlApiCommandOutput extends AssociateSourceGraphqlApiResponse, __MetadataBearer {} /** - *Creates an association between a Merged API and source API using the Merged API's identifier.
+ *Creates an association between a Merged API and source API using the Merged API's + * identifier.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -72,12 +73,12 @@ export interface AssociateSourceGraphqlApiCommandOutput extends AssociateSourceG * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
@@ -86,7 +87,8 @@ export interface AssociateSourceGraphqlApiCommandOutput extends AssociateSourceG *The request exceeded a limit. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/CreateApiCacheCommand.ts b/clients/client-appsync/src/commands/CreateApiCacheCommand.ts index 36fa17a1ba86..de59be5eaca0 100644 --- a/clients/client-appsync/src/commands/CreateApiCacheCommand.ts +++ b/clients/client-appsync/src/commands/CreateApiCacheCommand.ts @@ -67,18 +67,19 @@ export interface CreateApiCacheCommandOutput extends CreateApiCacheResponse, __M * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/CreateApiCommand.ts b/clients/client-appsync/src/commands/CreateApiCommand.ts new file mode 100644 index 000000000000..9fddab5035ec --- /dev/null +++ b/clients/client-appsync/src/commands/CreateApiCommand.ts @@ -0,0 +1,213 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateApiRequest, CreateApiResponse } from "../models/models_0"; +import { de_CreateApiCommand, se_CreateApiCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateApiCommand}. + */ +export interface CreateApiCommandInput extends CreateApiRequest {} +/** + * @public + * + * The output of {@link CreateApiCommand}. + */ +export interface CreateApiCommandOutput extends CreateApiResponse, __MetadataBearer {} + +/** + *Creates an Api object. Use this operation to create an AppSync
+ * API with your preferred configuration, such as an Event API that provides real-time message
+ * publishing and message subscriptions over WebSockets.
The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
+ * + * @throws {@link ConcurrentModificationException} (client fault) + *Another modification is in progress at this time and it must complete before you can + * make your change.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal AppSync error occurred. Try your request again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The operation exceeded the service quota for this resource.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You aren't authorized to perform this operation.
+ * + * @throws {@link AppSyncServiceException} + *Base exception class for all service exceptions from AppSync service.
+ * + * @public + */ +export class CreateApiCommand extends $Command + .classBuilder< + CreateApiCommandInput, + CreateApiCommandOutput, + AppSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: AppSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSDeepdishControlPlaneService", "CreateApi", {}) + .n("AppSyncClient", "CreateApiCommand") + .f(void 0, void 0) + .ser(se_CreateApiCommand) + .de(de_CreateApiCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateApiRequest; + output: CreateApiResponse; + }; + sdk: { + input: CreateApiCommandInput; + output: CreateApiCommandOutput; + }; + }; +} diff --git a/clients/client-appsync/src/commands/CreateApiKeyCommand.ts b/clients/client-appsync/src/commands/CreateApiKeyCommand.ts index 5149742ce258..dd35295881ae 100644 --- a/clients/client-appsync/src/commands/CreateApiKeyCommand.ts +++ b/clients/client-appsync/src/commands/CreateApiKeyCommand.ts @@ -67,8 +67,8 @@ export interface CreateApiKeyCommandOutput extends CreateApiKeyResponse, __Metad *CreateApiKey) or from update (for UpdateApiKey).
*
* @throws {@link BadRequestException} (client fault)
- * The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
@@ -77,7 +77,8 @@ export interface CreateApiKeyCommandOutput extends CreateApiKeyResponse, __Metad *The request exceeded a limit. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/CreateChannelNamespaceCommand.ts b/clients/client-appsync/src/commands/CreateChannelNamespaceCommand.ts new file mode 100644 index 000000000000..ead2cf8ec229 --- /dev/null +++ b/clients/client-appsync/src/commands/CreateChannelNamespaceCommand.ts @@ -0,0 +1,154 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateChannelNamespaceRequest, CreateChannelNamespaceResponse } from "../models/models_0"; +import { de_CreateChannelNamespaceCommand, se_CreateChannelNamespaceCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateChannelNamespaceCommand}. + */ +export interface CreateChannelNamespaceCommandInput extends CreateChannelNamespaceRequest {} +/** + * @public + * + * The output of {@link CreateChannelNamespaceCommand}. + */ +export interface CreateChannelNamespaceCommandOutput extends CreateChannelNamespaceResponse, __MetadataBearer {} + +/** + *Creates a ChannelNamespace for an Api.
The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
+ * + * @throws {@link ConcurrentModificationException} (client fault) + *Another modification is in progress at this time and it must complete before you can + * make your change.
+ * + * @throws {@link ConflictException} (client fault) + *A conflict with a previous successful update is detected. This typically + * occurs when the previous update did not have time to propagate before the next update was + * made. A retry (with appropriate backoff logic) is the recommended response to this + * exception.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal AppSync error occurred. Try your request again.
+ * + * @throws {@link NotFoundException} (client fault) + *The resource specified in the request was not found. Check the resource, and then try + * again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The operation exceeded the service quota for this resource.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You aren't authorized to perform this operation.
+ * + * @throws {@link AppSyncServiceException} + *Base exception class for all service exceptions from AppSync service.
+ * + * @public + */ +export class CreateChannelNamespaceCommand extends $Command + .classBuilder< + CreateChannelNamespaceCommandInput, + CreateChannelNamespaceCommandOutput, + AppSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: AppSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSDeepdishControlPlaneService", "CreateChannelNamespace", {}) + .n("AppSyncClient", "CreateChannelNamespaceCommand") + .f(void 0, void 0) + .ser(se_CreateChannelNamespaceCommand) + .de(de_CreateChannelNamespaceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateChannelNamespaceRequest; + output: CreateChannelNamespaceResponse; + }; + sdk: { + input: CreateChannelNamespaceCommandInput; + output: CreateChannelNamespaceCommandOutput; + }; + }; +} diff --git a/clients/client-appsync/src/commands/CreateDataSourceCommand.ts b/clients/client-appsync/src/commands/CreateDataSourceCommand.ts index 1ad92328d506..e81ecbc32b5a 100644 --- a/clients/client-appsync/src/commands/CreateDataSourceCommand.ts +++ b/clients/client-appsync/src/commands/CreateDataSourceCommand.ts @@ -155,18 +155,19 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse, * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/CreateDomainNameCommand.ts b/clients/client-appsync/src/commands/CreateDomainNameCommand.ts index 4e9524be2134..06b81e03102d 100644 --- a/clients/client-appsync/src/commands/CreateDomainNameCommand.ts +++ b/clients/client-appsync/src/commands/CreateDomainNameCommand.ts @@ -64,8 +64,8 @@ export interface CreateDomainNameCommandOutput extends CreateDomainNameResponse, *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
diff --git a/clients/client-appsync/src/commands/CreateFunctionCommand.ts b/clients/client-appsync/src/commands/CreateFunctionCommand.ts index 7cee385d12c3..b8c453df6a38 100644 --- a/clients/client-appsync/src/commands/CreateFunctionCommand.ts +++ b/clients/client-appsync/src/commands/CreateFunctionCommand.ts @@ -29,7 +29,8 @@ export interface CreateFunctionCommandOutput extends CreateFunctionResponse, __M /** *Creates a Function object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
+ *A function is a reusable entity. You can use multiple functions to compose the resolver + * logic.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -95,18 +96,19 @@ export interface CreateFunctionCommandOutput extends CreateFunctionResponse, __M * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/CreateGraphqlApiCommand.ts b/clients/client-appsync/src/commands/CreateGraphqlApiCommand.ts index b555ec1b24a9..3c6426e19f48 100644 --- a/clients/client-appsync/src/commands/CreateGraphqlApiCommand.ts +++ b/clients/client-appsync/src/commands/CreateGraphqlApiCommand.ts @@ -85,9 +85,9 @@ export interface CreateGraphqlApiCommandOutput extends CreateGraphqlApiResponse, * authorizerUri: "STRING_VALUE", // required * identityValidationExpression: "STRING_VALUE", * }, - * visibility: "GLOBAL" || "PRIVATE", * apiType: "GRAPHQL" || "MERGED", * mergedApiExecutionRoleArn: "STRING_VALUE", + * visibility: "GLOBAL" || "PRIVATE", * ownerContact: "STRING_VALUE", * introspectionConfig: "ENABLED" || "DISABLED", * queryDepthLimit: Number("int"), @@ -188,12 +188,12 @@ export interface CreateGraphqlApiCommandOutput extends CreateGraphqlApiResponse, *The GraphQL API exceeded a limit. Try your request again.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
diff --git a/clients/client-appsync/src/commands/CreateResolverCommand.ts b/clients/client-appsync/src/commands/CreateResolverCommand.ts index 2051ca05c443..45b92ceb5d9f 100644 --- a/clients/client-appsync/src/commands/CreateResolverCommand.ts +++ b/clients/client-appsync/src/commands/CreateResolverCommand.ts @@ -29,8 +29,8 @@ export interface CreateResolverCommandOutput extends CreateResolverResponse, __M /** *Creates a Resolver object.
A resolver converts incoming requests into a format that a data source can understand, and converts the data - * source's responses into GraphQL.
+ *A resolver converts incoming requests into a format that a data source can understand, + * and converts the data source's responses into GraphQL.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -119,18 +119,19 @@ export interface CreateResolverCommandOutput extends CreateResolverResponse, __M * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/CreateTypeCommand.ts b/clients/client-appsync/src/commands/CreateTypeCommand.ts index a631c083190f..a5b600f4787f 100644 --- a/clients/client-appsync/src/commands/CreateTypeCommand.ts +++ b/clients/client-appsync/src/commands/CreateTypeCommand.ts @@ -61,18 +61,19 @@ export interface CreateTypeCommandOutput extends CreateTypeResponse, __MetadataB * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/DeleteApiCacheCommand.ts b/clients/client-appsync/src/commands/DeleteApiCacheCommand.ts index 6a63ac058bf1..7ab99b69bc90 100644 --- a/clients/client-appsync/src/commands/DeleteApiCacheCommand.ts +++ b/clients/client-appsync/src/commands/DeleteApiCacheCommand.ts @@ -51,18 +51,19 @@ export interface DeleteApiCacheCommandOutput extends DeleteApiCacheResponse, __M * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/DeleteApiCommand.ts b/clients/client-appsync/src/commands/DeleteApiCommand.ts new file mode 100644 index 000000000000..c688ca28d512 --- /dev/null +++ b/clients/client-appsync/src/commands/DeleteApiCommand.ts @@ -0,0 +1,111 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteApiRequest, DeleteApiResponse } from "../models/models_0"; +import { de_DeleteApiCommand, se_DeleteApiCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteApiCommand}. + */ +export interface DeleteApiCommandInput extends DeleteApiRequest {} +/** + * @public + * + * The output of {@link DeleteApiCommand}. + */ +export interface DeleteApiCommandOutput extends DeleteApiResponse, __MetadataBearer {} + +/** + *Deletes an Api object
You don't have access to perform this operation on this resource.
+ * + * @throws {@link BadRequestException} (client fault) + *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
+ * + * @throws {@link ConcurrentModificationException} (client fault) + *Another modification is in progress at this time and it must complete before you can + * make your change.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal AppSync error occurred. Try your request again.
+ * + * @throws {@link NotFoundException} (client fault) + *The resource specified in the request was not found. Check the resource, and then try + * again.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You aren't authorized to perform this operation.
+ * + * @throws {@link AppSyncServiceException} + *Base exception class for all service exceptions from AppSync service.
+ * + * @public + */ +export class DeleteApiCommand extends $Command + .classBuilder< + DeleteApiCommandInput, + DeleteApiCommandOutput, + AppSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: AppSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSDeepdishControlPlaneService", "DeleteApi", {}) + .n("AppSyncClient", "DeleteApiCommand") + .f(void 0, void 0) + .ser(se_DeleteApiCommand) + .de(de_DeleteApiCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteApiRequest; + output: {}; + }; + sdk: { + input: DeleteApiCommandInput; + output: DeleteApiCommandOutput; + }; + }; +} diff --git a/clients/client-appsync/src/commands/DeleteApiKeyCommand.ts b/clients/client-appsync/src/commands/DeleteApiKeyCommand.ts index a7d7f92846b7..31e0766df86e 100644 --- a/clients/client-appsync/src/commands/DeleteApiKeyCommand.ts +++ b/clients/client-appsync/src/commands/DeleteApiKeyCommand.ts @@ -52,14 +52,15 @@ export interface DeleteApiKeyCommandOutput extends DeleteApiKeyResponse, __Metad * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/DeleteChannelNamespaceCommand.ts b/clients/client-appsync/src/commands/DeleteChannelNamespaceCommand.ts new file mode 100644 index 000000000000..c32ed0769947 --- /dev/null +++ b/clients/client-appsync/src/commands/DeleteChannelNamespaceCommand.ts @@ -0,0 +1,112 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteChannelNamespaceRequest, DeleteChannelNamespaceResponse } from "../models/models_0"; +import { de_DeleteChannelNamespaceCommand, se_DeleteChannelNamespaceCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteChannelNamespaceCommand}. + */ +export interface DeleteChannelNamespaceCommandInput extends DeleteChannelNamespaceRequest {} +/** + * @public + * + * The output of {@link DeleteChannelNamespaceCommand}. + */ +export interface DeleteChannelNamespaceCommandOutput extends DeleteChannelNamespaceResponse, __MetadataBearer {} + +/** + *Deletes a ChannelNamespace.
You don't have access to perform this operation on this resource.
+ * + * @throws {@link BadRequestException} (client fault) + *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
+ * + * @throws {@link ConcurrentModificationException} (client fault) + *Another modification is in progress at this time and it must complete before you can + * make your change.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal AppSync error occurred. Try your request again.
+ * + * @throws {@link NotFoundException} (client fault) + *The resource specified in the request was not found. Check the resource, and then try + * again.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You aren't authorized to perform this operation.
+ * + * @throws {@link AppSyncServiceException} + *Base exception class for all service exceptions from AppSync service.
+ * + * @public + */ +export class DeleteChannelNamespaceCommand extends $Command + .classBuilder< + DeleteChannelNamespaceCommandInput, + DeleteChannelNamespaceCommandOutput, + AppSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: AppSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSDeepdishControlPlaneService", "DeleteChannelNamespace", {}) + .n("AppSyncClient", "DeleteChannelNamespaceCommand") + .f(void 0, void 0) + .ser(se_DeleteChannelNamespaceCommand) + .de(de_DeleteChannelNamespaceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteChannelNamespaceRequest; + output: {}; + }; + sdk: { + input: DeleteChannelNamespaceCommandInput; + output: DeleteChannelNamespaceCommandOutput; + }; + }; +} diff --git a/clients/client-appsync/src/commands/DeleteDataSourceCommand.ts b/clients/client-appsync/src/commands/DeleteDataSourceCommand.ts index 8a0119805824..cd1e7c047304 100644 --- a/clients/client-appsync/src/commands/DeleteDataSourceCommand.ts +++ b/clients/client-appsync/src/commands/DeleteDataSourceCommand.ts @@ -52,18 +52,19 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse, * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/DeleteDomainNameCommand.ts b/clients/client-appsync/src/commands/DeleteDomainNameCommand.ts index 4ec81d4a66af..15f0ec61c1db 100644 --- a/clients/client-appsync/src/commands/DeleteDomainNameCommand.ts +++ b/clients/client-appsync/src/commands/DeleteDomainNameCommand.ts @@ -54,18 +54,19 @@ export interface DeleteDomainNameCommandOutput extends DeleteDomainNameResponse, *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link AppSyncServiceException} *Base exception class for all service exceptions from AppSync service.
diff --git a/clients/client-appsync/src/commands/DeleteFunctionCommand.ts b/clients/client-appsync/src/commands/DeleteFunctionCommand.ts index 6802779b4f53..6352a5eb036e 100644 --- a/clients/client-appsync/src/commands/DeleteFunctionCommand.ts +++ b/clients/client-appsync/src/commands/DeleteFunctionCommand.ts @@ -52,18 +52,19 @@ export interface DeleteFunctionCommandOutput extends DeleteFunctionResponse, __M * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/DeleteGraphqlApiCommand.ts b/clients/client-appsync/src/commands/DeleteGraphqlApiCommand.ts index 1617b054c153..8a48a08eda6d 100644 --- a/clients/client-appsync/src/commands/DeleteGraphqlApiCommand.ts +++ b/clients/client-appsync/src/commands/DeleteGraphqlApiCommand.ts @@ -54,18 +54,19 @@ export interface DeleteGraphqlApiCommandOutput extends DeleteGraphqlApiResponse, *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/DeleteResolverCommand.ts b/clients/client-appsync/src/commands/DeleteResolverCommand.ts index 21ee8fe5af98..1205300de2dc 100644 --- a/clients/client-appsync/src/commands/DeleteResolverCommand.ts +++ b/clients/client-appsync/src/commands/DeleteResolverCommand.ts @@ -53,18 +53,19 @@ export interface DeleteResolverCommandOutput extends DeleteResolverResponse, __M * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/DeleteTypeCommand.ts b/clients/client-appsync/src/commands/DeleteTypeCommand.ts index 4f4c72ee9d22..ef8c30c46d41 100644 --- a/clients/client-appsync/src/commands/DeleteTypeCommand.ts +++ b/clients/client-appsync/src/commands/DeleteTypeCommand.ts @@ -52,18 +52,19 @@ export interface DeleteTypeCommandOutput extends DeleteTypeResponse, __MetadataB * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/DisassociateApiCommand.ts b/clients/client-appsync/src/commands/DisassociateApiCommand.ts index c7c1afbc72a8..e87c81fddf72 100644 --- a/clients/client-appsync/src/commands/DisassociateApiCommand.ts +++ b/clients/client-appsync/src/commands/DisassociateApiCommand.ts @@ -54,18 +54,19 @@ export interface DisassociateApiCommandOutput extends DisassociateApiResponse, _ *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link AppSyncServiceException} *Base exception class for all service exceptions from AppSync service.
diff --git a/clients/client-appsync/src/commands/DisassociateMergedGraphqlApiCommand.ts b/clients/client-appsync/src/commands/DisassociateMergedGraphqlApiCommand.ts index e2690f9c3d4f..5d3c8354f1d9 100644 --- a/clients/client-appsync/src/commands/DisassociateMergedGraphqlApiCommand.ts +++ b/clients/client-appsync/src/commands/DisassociateMergedGraphqlApiCommand.ts @@ -33,8 +33,8 @@ export interface DisassociateMergedGraphqlApiCommandOutput __MetadataBearer {} /** - *Deletes an association between a Merged API and source API using the source API's identifier and the - * association ID.
+ *Deletes an association between a Merged API and source API using the source API's + * identifier and the association ID.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -60,18 +60,19 @@ export interface DisassociateMergedGraphqlApiCommandOutput * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/DisassociateSourceGraphqlApiCommand.ts b/clients/client-appsync/src/commands/DisassociateSourceGraphqlApiCommand.ts index f762a011ce81..b70d63a19dc1 100644 --- a/clients/client-appsync/src/commands/DisassociateSourceGraphqlApiCommand.ts +++ b/clients/client-appsync/src/commands/DisassociateSourceGraphqlApiCommand.ts @@ -33,8 +33,8 @@ export interface DisassociateSourceGraphqlApiCommandOutput __MetadataBearer {} /** - *Deletes an association between a Merged API and source API using the Merged API's identifier and the - * association ID.
+ *Deletes an association between a Merged API and source API using the Merged API's + * identifier and the association ID.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -60,18 +60,19 @@ export interface DisassociateSourceGraphqlApiCommandOutput * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/EvaluateCodeCommand.ts b/clients/client-appsync/src/commands/EvaluateCodeCommand.ts index 68338d8786c2..47640314d59f 100644 --- a/clients/client-appsync/src/commands/EvaluateCodeCommand.ts +++ b/clients/client-appsync/src/commands/EvaluateCodeCommand.ts @@ -28,11 +28,12 @@ export interface EvaluateCodeCommandInput extends EvaluateCodeRequest {} export interface EvaluateCodeCommandOutput extends EvaluateCodeResponse, __MetadataBearer {} /** - *Evaluates the given code and returns the response. The code definition requirements depend on the specified
- * runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request
- * function takes the incoming request after a GraphQL operation is parsed and converts it into a request
- * configuration for the selected data source operation. The response function interprets responses from the data
- * source and maps it to the shape of the GraphQL field output type.
Evaluates the given code and returns the response. The code definition requirements
+ * depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the
+ * request and response functions. The request function takes the incoming request after a
+ * GraphQL operation is parsed and converts it into a request configuration for the selected
+ * data source operation. The response function interprets responses from the data source and
+ * maps it to the shape of the GraphQL field output type.
You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
diff --git a/clients/client-appsync/src/commands/EvaluateMappingTemplateCommand.ts b/clients/client-appsync/src/commands/EvaluateMappingTemplateCommand.ts index 8869a908a603..83ad5eb3056c 100644 --- a/clients/client-appsync/src/commands/EvaluateMappingTemplateCommand.ts +++ b/clients/client-appsync/src/commands/EvaluateMappingTemplateCommand.ts @@ -28,11 +28,12 @@ export interface EvaluateMappingTemplateCommandInput extends EvaluateMappingTemp export interface EvaluateMappingTemplateCommandOutput extends EvaluateMappingTemplateResponse, __MetadataBearer {} /** - *Evaluates a given template and returns the response. The mapping template can be a request or response - * template.
- *Request templates take the incoming request after a GraphQL operation is parsed and convert it into a - * request configuration for the selected data source operation. Response templates interpret responses from the - * data source and map it to the shape of the GraphQL field output type.
+ *Evaluates a given template and returns the response. The mapping template can be a + * request or response template.
+ *Request templates take the incoming request after a GraphQL operation is parsed and + * convert it into a request configuration for the selected data source operation. Response + * templates interpret responses from the data source and map it to the shape of the GraphQL + * field output type.
*Mapping templates are written in the Apache Velocity Template Language (VTL).
* @example * Use a bare-bones client and the command you need to make an API call. @@ -68,8 +69,8 @@ export interface EvaluateMappingTemplateCommandOutput extends EvaluateMappingTem *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
diff --git a/clients/client-appsync/src/commands/FlushApiCacheCommand.ts b/clients/client-appsync/src/commands/FlushApiCacheCommand.ts index 0d68ef227ab6..e36edeefcefe 100644 --- a/clients/client-appsync/src/commands/FlushApiCacheCommand.ts +++ b/clients/client-appsync/src/commands/FlushApiCacheCommand.ts @@ -51,18 +51,19 @@ export interface FlushApiCacheCommandOutput extends FlushApiCacheResponse, __Met * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/GetApiAssociationCommand.ts b/clients/client-appsync/src/commands/GetApiAssociationCommand.ts index 5bdf81884d43..f4dda991c3b9 100644 --- a/clients/client-appsync/src/commands/GetApiAssociationCommand.ts +++ b/clients/client-appsync/src/commands/GetApiAssociationCommand.ts @@ -61,14 +61,15 @@ export interface GetApiAssociationCommandOutput extends GetApiAssociationRespons *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link AppSyncServiceException} *Base exception class for all service exceptions from AppSync service.
diff --git a/clients/client-appsync/src/commands/GetApiCacheCommand.ts b/clients/client-appsync/src/commands/GetApiCacheCommand.ts index fa99c627a9d2..c8f95931fced 100644 --- a/clients/client-appsync/src/commands/GetApiCacheCommand.ts +++ b/clients/client-appsync/src/commands/GetApiCacheCommand.ts @@ -61,18 +61,19 @@ export interface GetApiCacheCommandOutput extends GetApiCacheResponse, __Metadat * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/GetApiCommand.ts b/clients/client-appsync/src/commands/GetApiCommand.ts new file mode 100644 index 000000000000..bb089337d101 --- /dev/null +++ b/clients/client-appsync/src/commands/GetApiCommand.ts @@ -0,0 +1,165 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetApiRequest, GetApiResponse } from "../models/models_0"; +import { de_GetApiCommand, se_GetApiCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetApiCommand}. + */ +export interface GetApiCommandInput extends GetApiRequest {} +/** + * @public + * + * The output of {@link GetApiCommand}. + */ +export interface GetApiCommandOutput extends GetApiResponse, __MetadataBearer {} + +/** + *Retrieves an Api object.
You don't have access to perform this operation on this resource.
+ * + * @throws {@link BadRequestException} (client fault) + *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal AppSync error occurred. Try your request again.
+ * + * @throws {@link NotFoundException} (client fault) + *The resource specified in the request was not found. Check the resource, and then try + * again.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You aren't authorized to perform this operation.
+ * + * @throws {@link AppSyncServiceException} + *Base exception class for all service exceptions from AppSync service.
+ * + * @public + */ +export class GetApiCommand extends $Command + .classBuilder< + GetApiCommandInput, + GetApiCommandOutput, + AppSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: AppSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSDeepdishControlPlaneService", "GetApi", {}) + .n("AppSyncClient", "GetApiCommand") + .f(void 0, void 0) + .ser(se_GetApiCommand) + .de(de_GetApiCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetApiRequest; + output: GetApiResponse; + }; + sdk: { + input: GetApiCommandInput; + output: GetApiCommandOutput; + }; + }; +} diff --git a/clients/client-appsync/src/commands/GetChannelNamespaceCommand.ts b/clients/client-appsync/src/commands/GetChannelNamespaceCommand.ts new file mode 100644 index 000000000000..773a69437f8e --- /dev/null +++ b/clients/client-appsync/src/commands/GetChannelNamespaceCommand.ts @@ -0,0 +1,130 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetChannelNamespaceRequest, GetChannelNamespaceResponse } from "../models/models_0"; +import { de_GetChannelNamespaceCommand, se_GetChannelNamespaceCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetChannelNamespaceCommand}. + */ +export interface GetChannelNamespaceCommandInput extends GetChannelNamespaceRequest {} +/** + * @public + * + * The output of {@link GetChannelNamespaceCommand}. + */ +export interface GetChannelNamespaceCommandOutput extends GetChannelNamespaceResponse, __MetadataBearer {} + +/** + *Retrieves the channel namespace for a specified Api.
You don't have access to perform this operation on this resource.
+ * + * @throws {@link BadRequestException} (client fault) + *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal AppSync error occurred. Try your request again.
+ * + * @throws {@link NotFoundException} (client fault) + *The resource specified in the request was not found. Check the resource, and then try + * again.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You aren't authorized to perform this operation.
+ * + * @throws {@link AppSyncServiceException} + *Base exception class for all service exceptions from AppSync service.
+ * + * @public + */ +export class GetChannelNamespaceCommand extends $Command + .classBuilder< + GetChannelNamespaceCommandInput, + GetChannelNamespaceCommandOutput, + AppSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: AppSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSDeepdishControlPlaneService", "GetChannelNamespace", {}) + .n("AppSyncClient", "GetChannelNamespaceCommand") + .f(void 0, void 0) + .ser(se_GetChannelNamespaceCommand) + .de(de_GetChannelNamespaceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetChannelNamespaceRequest; + output: GetChannelNamespaceResponse; + }; + sdk: { + input: GetChannelNamespaceCommandInput; + output: GetChannelNamespaceCommandOutput; + }; + }; +} diff --git a/clients/client-appsync/src/commands/GetDataSourceCommand.ts b/clients/client-appsync/src/commands/GetDataSourceCommand.ts index 7efa6ffef415..0020037bd1de 100644 --- a/clients/client-appsync/src/commands/GetDataSourceCommand.ts +++ b/clients/client-appsync/src/commands/GetDataSourceCommand.ts @@ -106,18 +106,19 @@ export interface GetDataSourceCommandOutput extends GetDataSourceResponse, __Met * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/GetDataSourceIntrospectionCommand.ts b/clients/client-appsync/src/commands/GetDataSourceIntrospectionCommand.ts index 0ee8eb75eea4..4e170458875a 100644 --- a/clients/client-appsync/src/commands/GetDataSourceIntrospectionCommand.ts +++ b/clients/client-appsync/src/commands/GetDataSourceIntrospectionCommand.ts @@ -28,9 +28,9 @@ export interface GetDataSourceIntrospectionCommandInput extends GetDataSourceInt export interface GetDataSourceIntrospectionCommandOutput extends GetDataSourceIntrospectionResponse, __MetadataBearer {} /** - *Retrieves the record of an existing introspection. If the retrieval is successful, the result of the - * instrospection will also be returned. If the retrieval fails the operation, an error message will be returned - * instead.
+ *Retrieves the record of an existing introspection. If the retrieval is successful, the + * result of the instrospection will also be returned. If the retrieval fails the operation, + * an error message will be returned instead.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -104,14 +104,15 @@ export interface GetDataSourceIntrospectionCommandOutput extends GetDataSourceIn * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link AppSyncServiceException} *Base exception class for all service exceptions from AppSync service.
diff --git a/clients/client-appsync/src/commands/GetDomainNameCommand.ts b/clients/client-appsync/src/commands/GetDomainNameCommand.ts index afd2ea825cf0..efd769c212df 100644 --- a/clients/client-appsync/src/commands/GetDomainNameCommand.ts +++ b/clients/client-appsync/src/commands/GetDomainNameCommand.ts @@ -62,14 +62,15 @@ export interface GetDomainNameCommandOutput extends GetDomainNameResponse, __Met *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link AppSyncServiceException} *Base exception class for all service exceptions from AppSync service.
diff --git a/clients/client-appsync/src/commands/GetFunctionCommand.ts b/clients/client-appsync/src/commands/GetFunctionCommand.ts index adb9e83cdae9..6688b1e59f54 100644 --- a/clients/client-appsync/src/commands/GetFunctionCommand.ts +++ b/clients/client-appsync/src/commands/GetFunctionCommand.ts @@ -76,11 +76,12 @@ export interface GetFunctionCommandOutput extends GetFunctionResponse, __Metadat * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/GetGraphqlApiCommand.ts b/clients/client-appsync/src/commands/GetGraphqlApiCommand.ts index c77ada6cfeda..801a0650d6ed 100644 --- a/clients/client-appsync/src/commands/GetGraphqlApiCommand.ts +++ b/clients/client-appsync/src/commands/GetGraphqlApiCommand.ts @@ -128,14 +128,15 @@ export interface GetGraphqlApiCommandOutput extends GetGraphqlApiResponse, __Met *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/GetGraphqlApiEnvironmentVariablesCommand.ts b/clients/client-appsync/src/commands/GetGraphqlApiEnvironmentVariablesCommand.ts index 3952a7d385e2..b3ad14fb8794 100644 --- a/clients/client-appsync/src/commands/GetGraphqlApiEnvironmentVariablesCommand.ts +++ b/clients/client-appsync/src/commands/GetGraphqlApiEnvironmentVariablesCommand.ts @@ -36,7 +36,8 @@ export interface GetGraphqlApiEnvironmentVariablesCommandOutput __MetadataBearer {} /** - *Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
+ *Retrieves the list of environmental variable key-value pairs associated with an API by + * its ID value.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -66,14 +67,15 @@ export interface GetGraphqlApiEnvironmentVariablesCommandOutput *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/GetIntrospectionSchemaCommand.ts b/clients/client-appsync/src/commands/GetIntrospectionSchemaCommand.ts index 4b33ced03f1b..e1eaa8d70685 100644 --- a/clients/client-appsync/src/commands/GetIntrospectionSchemaCommand.ts +++ b/clients/client-appsync/src/commands/GetIntrospectionSchemaCommand.ts @@ -71,7 +71,8 @@ export interface GetIntrospectionSchemaCommandOutput *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/GetResolverCommand.ts b/clients/client-appsync/src/commands/GetResolverCommand.ts index c1a826c4467b..face2bcedef3 100644 --- a/clients/client-appsync/src/commands/GetResolverCommand.ts +++ b/clients/client-appsync/src/commands/GetResolverCommand.ts @@ -88,11 +88,12 @@ export interface GetResolverCommandOutput extends GetResolverResponse, __Metadat * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/GetSchemaCreationStatusCommand.ts b/clients/client-appsync/src/commands/GetSchemaCreationStatusCommand.ts index f380d0c34fb4..bbfb2c97233d 100644 --- a/clients/client-appsync/src/commands/GetSchemaCreationStatusCommand.ts +++ b/clients/client-appsync/src/commands/GetSchemaCreationStatusCommand.ts @@ -54,14 +54,15 @@ export interface GetSchemaCreationStatusCommandOutput extends GetSchemaCreationS * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/GetSourceApiAssociationCommand.ts b/clients/client-appsync/src/commands/GetSourceApiAssociationCommand.ts index 48087e076a08..5643bd9f2e81 100644 --- a/clients/client-appsync/src/commands/GetSourceApiAssociationCommand.ts +++ b/clients/client-appsync/src/commands/GetSourceApiAssociationCommand.ts @@ -68,14 +68,15 @@ export interface GetSourceApiAssociationCommandOutput extends GetSourceApiAssoci * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/GetTypeCommand.ts b/clients/client-appsync/src/commands/GetTypeCommand.ts index accaaf24d338..d05af52a00bb 100644 --- a/clients/client-appsync/src/commands/GetTypeCommand.ts +++ b/clients/client-appsync/src/commands/GetTypeCommand.ts @@ -61,18 +61,19 @@ export interface GetTypeCommandOutput extends GetTypeResponse, __MetadataBearer * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/ListApiKeysCommand.ts b/clients/client-appsync/src/commands/ListApiKeysCommand.ts index 974496e962ae..4a738f3a7566 100644 --- a/clients/client-appsync/src/commands/ListApiKeysCommand.ts +++ b/clients/client-appsync/src/commands/ListApiKeysCommand.ts @@ -30,9 +30,10 @@ export interface ListApiKeysCommandOutput extends ListApiKeysResponse, __Metadat /** *Lists the API keys for a given API.
*API keys are deleted automatically 60 days after they expire. However, they may still be included in the
- * response until they have actually been deleted. You can safely call DeleteApiKey to manually
- * delete a key before it's automatically deleted.
API keys are deleted automatically 60 days after they expire. However, they may still
+ * be included in the response until they have actually been deleted. You can safely call
+ * DeleteApiKey to manually delete a key before it's automatically
+ * deleted.
The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/ListApisCommand.ts b/clients/client-appsync/src/commands/ListApisCommand.ts new file mode 100644 index 000000000000..dcf63a0ee8e0 --- /dev/null +++ b/clients/client-appsync/src/commands/ListApisCommand.ts @@ -0,0 +1,165 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListApisRequest, ListApisResponse } from "../models/models_0"; +import { de_ListApisCommand, se_ListApisCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListApisCommand}. + */ +export interface ListApisCommandInput extends ListApisRequest {} +/** + * @public + * + * The output of {@link ListApisCommand}. + */ +export interface ListApisCommandOutput extends ListApisResponse, __MetadataBearer {} + +/** + *Lists the APIs in your AppSync account.
+ *
+ * ListApis returns only the high level API details. For more detailed
+ * information about an API, use GetApi.
The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal AppSync error occurred. Try your request again.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You aren't authorized to perform this operation.
+ * + * @throws {@link AppSyncServiceException} + *Base exception class for all service exceptions from AppSync service.
+ * + * @public + */ +export class ListApisCommand extends $Command + .classBuilder< + ListApisCommandInput, + ListApisCommandOutput, + AppSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: AppSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSDeepdishControlPlaneService", "ListApis", {}) + .n("AppSyncClient", "ListApisCommand") + .f(void 0, void 0) + .ser(se_ListApisCommand) + .de(de_ListApisCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListApisRequest; + output: ListApisResponse; + }; + sdk: { + input: ListApisCommandInput; + output: ListApisCommandOutput; + }; + }; +} diff --git a/clients/client-appsync/src/commands/ListChannelNamespacesCommand.ts b/clients/client-appsync/src/commands/ListChannelNamespacesCommand.ts new file mode 100644 index 000000000000..41251e833a4f --- /dev/null +++ b/clients/client-appsync/src/commands/ListChannelNamespacesCommand.ts @@ -0,0 +1,135 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListChannelNamespacesRequest, ListChannelNamespacesResponse } from "../models/models_0"; +import { de_ListChannelNamespacesCommand, se_ListChannelNamespacesCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListChannelNamespacesCommand}. + */ +export interface ListChannelNamespacesCommandInput extends ListChannelNamespacesRequest {} +/** + * @public + * + * The output of {@link ListChannelNamespacesCommand}. + */ +export interface ListChannelNamespacesCommandOutput extends ListChannelNamespacesResponse, __MetadataBearer {} + +/** + *Lists the channel namespaces for a specified Api.
+ * ListChannelNamespaces returns only high level details for the channel
+ * namespace. To retrieve code handlers, use
+ * GetChannelNamespace.
The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal AppSync error occurred. Try your request again.
+ * + * @throws {@link NotFoundException} (client fault) + *The resource specified in the request was not found. Check the resource, and then try + * again.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You aren't authorized to perform this operation.
+ * + * @throws {@link AppSyncServiceException} + *Base exception class for all service exceptions from AppSync service.
+ * + * @public + */ +export class ListChannelNamespacesCommand extends $Command + .classBuilder< + ListChannelNamespacesCommandInput, + ListChannelNamespacesCommandOutput, + AppSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: AppSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSDeepdishControlPlaneService", "ListChannelNamespaces", {}) + .n("AppSyncClient", "ListChannelNamespacesCommand") + .f(void 0, void 0) + .ser(se_ListChannelNamespacesCommand) + .de(de_ListChannelNamespacesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListChannelNamespacesRequest; + output: ListChannelNamespacesResponse; + }; + sdk: { + input: ListChannelNamespacesCommandInput; + output: ListChannelNamespacesCommandOutput; + }; + }; +} diff --git a/clients/client-appsync/src/commands/ListDataSourcesCommand.ts b/clients/client-appsync/src/commands/ListDataSourcesCommand.ts index 252194a01285..5259ff55279a 100644 --- a/clients/client-appsync/src/commands/ListDataSourcesCommand.ts +++ b/clients/client-appsync/src/commands/ListDataSourcesCommand.ts @@ -110,14 +110,15 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _ * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/ListDomainNamesCommand.ts b/clients/client-appsync/src/commands/ListDomainNamesCommand.ts index cb6341b0a9e6..9fd505ae87f9 100644 --- a/clients/client-appsync/src/commands/ListDomainNamesCommand.ts +++ b/clients/client-appsync/src/commands/ListDomainNamesCommand.ts @@ -66,8 +66,8 @@ export interface ListDomainNamesCommandOutput extends ListDomainNamesResponse, _ *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
diff --git a/clients/client-appsync/src/commands/ListFunctionsCommand.ts b/clients/client-appsync/src/commands/ListFunctionsCommand.ts index 18d2311f36f7..72dfd7177749 100644 --- a/clients/client-appsync/src/commands/ListFunctionsCommand.ts +++ b/clients/client-appsync/src/commands/ListFunctionsCommand.ts @@ -80,14 +80,15 @@ export interface ListFunctionsCommandOutput extends ListFunctionsResponse, __Met * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/ListGraphqlApisCommand.ts b/clients/client-appsync/src/commands/ListGraphqlApisCommand.ts index 4fff15ea9447..343f6b9e000d 100644 --- a/clients/client-appsync/src/commands/ListGraphqlApisCommand.ts +++ b/clients/client-appsync/src/commands/ListGraphqlApisCommand.ts @@ -131,8 +131,8 @@ export interface ListGraphqlApisCommandOutput extends ListGraphqlApisResponse, _ * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
diff --git a/clients/client-appsync/src/commands/ListResolversByFunctionCommand.ts b/clients/client-appsync/src/commands/ListResolversByFunctionCommand.ts index 407cc948b2a2..2f74993f5c48 100644 --- a/clients/client-appsync/src/commands/ListResolversByFunctionCommand.ts +++ b/clients/client-appsync/src/commands/ListResolversByFunctionCommand.ts @@ -92,14 +92,15 @@ export interface ListResolversByFunctionCommandOutput extends ListResolversByFun * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/ListResolversCommand.ts b/clients/client-appsync/src/commands/ListResolversCommand.ts index 00241b68fc8e..2244c71f1b90 100644 --- a/clients/client-appsync/src/commands/ListResolversCommand.ts +++ b/clients/client-appsync/src/commands/ListResolversCommand.ts @@ -92,14 +92,15 @@ export interface ListResolversCommandOutput extends ListResolversResponse, __Met * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/ListSourceApiAssociationsCommand.ts b/clients/client-appsync/src/commands/ListSourceApiAssociationsCommand.ts index b7c31517f8ae..93f57cca28da 100644 --- a/clients/client-appsync/src/commands/ListSourceApiAssociationsCommand.ts +++ b/clients/client-appsync/src/commands/ListSourceApiAssociationsCommand.ts @@ -66,14 +66,15 @@ export interface ListSourceApiAssociationsCommandOutput extends ListSourceApiAss * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/ListTagsForResourceCommand.ts b/clients/client-appsync/src/commands/ListTagsForResourceCommand.ts index b6c2e96e7569..66316e8815af 100644 --- a/clients/client-appsync/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-appsync/src/commands/ListTagsForResourceCommand.ts @@ -58,8 +58,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
@@ -68,7 +68,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *The request exceeded a limit. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/ListTypesByAssociationCommand.ts b/clients/client-appsync/src/commands/ListTypesByAssociationCommand.ts index 45e15a62378a..7bbf297b816b 100644 --- a/clients/client-appsync/src/commands/ListTypesByAssociationCommand.ts +++ b/clients/client-appsync/src/commands/ListTypesByAssociationCommand.ts @@ -66,18 +66,19 @@ export interface ListTypesByAssociationCommandOutput extends ListTypesByAssociat * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/ListTypesCommand.ts b/clients/client-appsync/src/commands/ListTypesCommand.ts index a9e79e294a97..1ad317a889e5 100644 --- a/clients/client-appsync/src/commands/ListTypesCommand.ts +++ b/clients/client-appsync/src/commands/ListTypesCommand.ts @@ -65,18 +65,19 @@ export interface ListTypesCommandOutput extends ListTypesResponse, __MetadataBea * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/PutGraphqlApiEnvironmentVariablesCommand.ts b/clients/client-appsync/src/commands/PutGraphqlApiEnvironmentVariablesCommand.ts index b8a235d78a8b..e87182560208 100644 --- a/clients/client-appsync/src/commands/PutGraphqlApiEnvironmentVariablesCommand.ts +++ b/clients/client-appsync/src/commands/PutGraphqlApiEnvironmentVariablesCommand.ts @@ -49,15 +49,16 @@ export interface PutGraphqlApiEnvironmentVariablesCommandOutput *Environmental variables only support string values.
* *Any defined value in an environmental variable is considered a string literal and not - * expanded.
+ *Any defined value in an environmental variable is considered a string literal + * and not expanded.
*Variable evaluations should ideally be performed in the function code.
+ *Variable evaluations should ideally be performed in the function + * code.
*When creating an environmental variable key-value pair, it must follow the additional constraints - * below:
+ *When creating an environmental variable key-value pair, it must follow the additional + * constraints below:
*Keys must begin with a letter.
@@ -66,7 +67,8 @@ export interface PutGraphqlApiEnvironmentVariablesCommandOutput *Keys must be at least two characters long.
*Keys can only contain letters, numbers, and the underscore character (_).
+ *Keys can only contain letters, numbers, and the underscore character + * (_).
*Values can be up to 512 characters long.
@@ -75,12 +77,13 @@ export interface PutGraphqlApiEnvironmentVariablesCommandOutput *You can configure up to 50 key-value pairs in a GraphQL API.
*You can create a list of environmental variables by adding it to the environmentVariables
- * payload as a list in the format \{"key1":"value1","key2":"value2", …\}. Note that each call of the
- * PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing
- * environmental variable list of that API. This means the existing environmental variables will be lost. To avoid
- * this, you must include all existing and new environmental variables in the list each time you call this
- * action.
You can create a list of environmental variables by adding it to the
+ * environmentVariables payload as a list in the format
+ * \{"key1":"value1","key2":"value2", …\}. Note that each call of the
+ * PutGraphqlApiEnvironmentVariables action will result in the overwriting of
+ * the existing environmental variable list of that API. This means the existing environmental
+ * variables will be lost. To avoid this, you must include all existing and new environmental
+ * variables in the list each time you call this action.
You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/StartDataSourceIntrospectionCommand.ts b/clients/client-appsync/src/commands/StartDataSourceIntrospectionCommand.ts index 209231300ff7..6befa1bc4a96 100644 --- a/clients/client-appsync/src/commands/StartDataSourceIntrospectionCommand.ts +++ b/clients/client-appsync/src/commands/StartDataSourceIntrospectionCommand.ts @@ -33,8 +33,8 @@ export interface StartDataSourceIntrospectionCommandOutput __MetadataBearer {} /** - *Creates a new introspection. Returns the introspectionId of the new introspection after its
- * creation.
Creates a new introspection. Returns the introspectionId of the new
+ * introspection after its creation.
The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/StartSchemaCreationCommand.ts b/clients/client-appsync/src/commands/StartSchemaCreationCommand.ts index 5462a50041ac..0cb04aeeb9de 100644 --- a/clients/client-appsync/src/commands/StartSchemaCreationCommand.ts +++ b/clients/client-appsync/src/commands/StartSchemaCreationCommand.ts @@ -29,8 +29,8 @@ export interface StartSchemaCreationCommandOutput extends StartSchemaCreationRes /** *Adds a new schema to your GraphQL API.
- *This operation is asynchronous. Use to determine when it has - * completed.
+ *This operation is asynchronous. Use to + * determine when it has completed.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -56,18 +56,19 @@ export interface StartSchemaCreationCommandOutput extends StartSchemaCreationRes * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/StartSchemaMergeCommand.ts b/clients/client-appsync/src/commands/StartSchemaMergeCommand.ts index 4eb83b950f3d..3cbcb3c160c9 100644 --- a/clients/client-appsync/src/commands/StartSchemaMergeCommand.ts +++ b/clients/client-appsync/src/commands/StartSchemaMergeCommand.ts @@ -28,7 +28,8 @@ export interface StartSchemaMergeCommandInput extends StartSchemaMergeRequest {} export interface StartSchemaMergeCommandOutput extends StartSchemaMergeResponse, __MetadataBearer {} /** - *Initiates a merge operation. Returns a status that shows the result of the merge operation.
+ *Initiates a merge operation. Returns a status that shows the result of the merge + * operation.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -54,18 +55,19 @@ export interface StartSchemaMergeCommandOutput extends StartSchemaMergeResponse, * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/TagResourceCommand.ts b/clients/client-appsync/src/commands/TagResourceCommand.ts index 1137b39c3e1c..d8cf914c10d3 100644 --- a/clients/client-appsync/src/commands/TagResourceCommand.ts +++ b/clients/client-appsync/src/commands/TagResourceCommand.ts @@ -57,8 +57,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
@@ -67,7 +67,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *The request exceeded a limit. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/UntagResourceCommand.ts b/clients/client-appsync/src/commands/UntagResourceCommand.ts index 348456a0d6d8..6bf47848c8d1 100644 --- a/clients/client-appsync/src/commands/UntagResourceCommand.ts +++ b/clients/client-appsync/src/commands/UntagResourceCommand.ts @@ -57,8 +57,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
@@ -67,7 +67,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *The request exceeded a limit. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/UpdateApiCacheCommand.ts b/clients/client-appsync/src/commands/UpdateApiCacheCommand.ts index 02654a4e7a1d..2ab4658df13c 100644 --- a/clients/client-appsync/src/commands/UpdateApiCacheCommand.ts +++ b/clients/client-appsync/src/commands/UpdateApiCacheCommand.ts @@ -65,18 +65,19 @@ export interface UpdateApiCacheCommandOutput extends UpdateApiCacheResponse, __M * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/UpdateApiCommand.ts b/clients/client-appsync/src/commands/UpdateApiCommand.ts new file mode 100644 index 000000000000..753763226eed --- /dev/null +++ b/clients/client-appsync/src/commands/UpdateApiCommand.ts @@ -0,0 +1,213 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateApiRequest, UpdateApiResponse } from "../models/models_0"; +import { de_UpdateApiCommand, se_UpdateApiCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateApiCommand}. + */ +export interface UpdateApiCommandInput extends UpdateApiRequest {} +/** + * @public + * + * The output of {@link UpdateApiCommand}. + */ +export interface UpdateApiCommandOutput extends UpdateApiResponse, __MetadataBearer {} + +/** + *Updates an Api.
You don't have access to perform this operation on this resource.
+ * + * @throws {@link BadRequestException} (client fault) + *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
+ * + * @throws {@link ConcurrentModificationException} (client fault) + *Another modification is in progress at this time and it must complete before you can + * make your change.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal AppSync error occurred. Try your request again.
+ * + * @throws {@link NotFoundException} (client fault) + *The resource specified in the request was not found. Check the resource, and then try + * again.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You aren't authorized to perform this operation.
+ * + * @throws {@link AppSyncServiceException} + *Base exception class for all service exceptions from AppSync service.
+ * + * @public + */ +export class UpdateApiCommand extends $Command + .classBuilder< + UpdateApiCommandInput, + UpdateApiCommandOutput, + AppSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: AppSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSDeepdishControlPlaneService", "UpdateApi", {}) + .n("AppSyncClient", "UpdateApiCommand") + .f(void 0, void 0) + .ser(se_UpdateApiCommand) + .de(de_UpdateApiCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateApiRequest; + output: UpdateApiResponse; + }; + sdk: { + input: UpdateApiCommandInput; + output: UpdateApiCommandOutput; + }; + }; +} diff --git a/clients/client-appsync/src/commands/UpdateApiKeyCommand.ts b/clients/client-appsync/src/commands/UpdateApiKeyCommand.ts index 4fb6a98a02e1..39aa88e332fe 100644 --- a/clients/client-appsync/src/commands/UpdateApiKeyCommand.ts +++ b/clients/client-appsync/src/commands/UpdateApiKeyCommand.ts @@ -65,8 +65,8 @@ export interface UpdateApiKeyCommandOutput extends UpdateApiKeyResponse, __Metad *CreateApiKey) or from update (for UpdateApiKey).
*
* @throws {@link BadRequestException} (client fault)
- * The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
@@ -75,7 +75,8 @@ export interface UpdateApiKeyCommandOutput extends UpdateApiKeyResponse, __Metad *The request exceeded a limit. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/UpdateChannelNamespaceCommand.ts b/clients/client-appsync/src/commands/UpdateChannelNamespaceCommand.ts new file mode 100644 index 000000000000..807e99ec9160 --- /dev/null +++ b/clients/client-appsync/src/commands/UpdateChannelNamespaceCommand.ts @@ -0,0 +1,145 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { AppSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppSyncClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateChannelNamespaceRequest, UpdateChannelNamespaceResponse } from "../models/models_0"; +import { de_UpdateChannelNamespaceCommand, se_UpdateChannelNamespaceCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateChannelNamespaceCommand}. + */ +export interface UpdateChannelNamespaceCommandInput extends UpdateChannelNamespaceRequest {} +/** + * @public + * + * The output of {@link UpdateChannelNamespaceCommand}. + */ +export interface UpdateChannelNamespaceCommandOutput extends UpdateChannelNamespaceResponse, __MetadataBearer {} + +/** + *Updates a ChannelNamespace associated with an Api.
You don't have access to perform this operation on this resource.
+ * + * @throws {@link BadRequestException} (client fault) + *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
+ * + * @throws {@link ConcurrentModificationException} (client fault) + *Another modification is in progress at this time and it must complete before you can + * make your change.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal AppSync error occurred. Try your request again.
+ * + * @throws {@link NotFoundException} (client fault) + *The resource specified in the request was not found. Check the resource, and then try + * again.
+ * + * @throws {@link UnauthorizedException} (client fault) + *You aren't authorized to perform this operation.
+ * + * @throws {@link AppSyncServiceException} + *Base exception class for all service exceptions from AppSync service.
+ * + * @public + */ +export class UpdateChannelNamespaceCommand extends $Command + .classBuilder< + UpdateChannelNamespaceCommandInput, + UpdateChannelNamespaceCommandOutput, + AppSyncClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: AppSyncClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSDeepdishControlPlaneService", "UpdateChannelNamespace", {}) + .n("AppSyncClient", "UpdateChannelNamespaceCommand") + .f(void 0, void 0) + .ser(se_UpdateChannelNamespaceCommand) + .de(de_UpdateChannelNamespaceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateChannelNamespaceRequest; + output: UpdateChannelNamespaceResponse; + }; + sdk: { + input: UpdateChannelNamespaceCommandInput; + output: UpdateChannelNamespaceCommandOutput; + }; + }; +} diff --git a/clients/client-appsync/src/commands/UpdateDataSourceCommand.ts b/clients/client-appsync/src/commands/UpdateDataSourceCommand.ts index 49764f01f769..f3df339271b1 100644 --- a/clients/client-appsync/src/commands/UpdateDataSourceCommand.ts +++ b/clients/client-appsync/src/commands/UpdateDataSourceCommand.ts @@ -155,18 +155,19 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse, * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/UpdateDomainNameCommand.ts b/clients/client-appsync/src/commands/UpdateDomainNameCommand.ts index a8a6604f840d..62eea045f28b 100644 --- a/clients/client-appsync/src/commands/UpdateDomainNameCommand.ts +++ b/clients/client-appsync/src/commands/UpdateDomainNameCommand.ts @@ -63,18 +63,19 @@ export interface UpdateDomainNameCommandOutput extends UpdateDomainNameResponse, *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link AppSyncServiceException} *Base exception class for all service exceptions from AppSync service.
diff --git a/clients/client-appsync/src/commands/UpdateFunctionCommand.ts b/clients/client-appsync/src/commands/UpdateFunctionCommand.ts index 6b2e1a7845fd..6cacda03023c 100644 --- a/clients/client-appsync/src/commands/UpdateFunctionCommand.ts +++ b/clients/client-appsync/src/commands/UpdateFunctionCommand.ts @@ -95,18 +95,19 @@ export interface UpdateFunctionCommandOutput extends UpdateFunctionResponse, __M * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/UpdateGraphqlApiCommand.ts b/clients/client-appsync/src/commands/UpdateGraphqlApiCommand.ts index 600b86164efb..94c48b141e11 100644 --- a/clients/client-appsync/src/commands/UpdateGraphqlApiCommand.ts +++ b/clients/client-appsync/src/commands/UpdateGraphqlApiCommand.ts @@ -43,7 +43,7 @@ export interface UpdateGraphqlApiCommandOutput extends UpdateGraphqlApiResponse, * cloudWatchLogsRoleArn: "STRING_VALUE", // required * excludeVerboseContent: true || false, * }, - * authenticationType: "API_KEY" || "AWS_IAM" || "AMAZON_COGNITO_USER_POOLS" || "OPENID_CONNECT" || "AWS_LAMBDA", // required + * authenticationType: "API_KEY" || "AWS_IAM" || "AMAZON_COGNITO_USER_POOLS" || "OPENID_CONNECT" || "AWS_LAMBDA", * userPoolConfig: { // UserPoolConfig * userPoolId: "STRING_VALUE", // required * awsRegion: "STRING_VALUE", // required @@ -184,18 +184,19 @@ export interface UpdateGraphqlApiCommandOutput extends UpdateGraphqlApiResponse, *You don't have access to perform this operation on this resource.
* * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/UpdateResolverCommand.ts b/clients/client-appsync/src/commands/UpdateResolverCommand.ts index ce7d6607f9c5..1283f6696ebe 100644 --- a/clients/client-appsync/src/commands/UpdateResolverCommand.ts +++ b/clients/client-appsync/src/commands/UpdateResolverCommand.ts @@ -117,18 +117,19 @@ export interface UpdateResolverCommandOutput extends UpdateResolverResponse, __M * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/UpdateSourceApiAssociationCommand.ts b/clients/client-appsync/src/commands/UpdateSourceApiAssociationCommand.ts index df9d8fac04c9..4c0e04e3a953 100644 --- a/clients/client-appsync/src/commands/UpdateSourceApiAssociationCommand.ts +++ b/clients/client-appsync/src/commands/UpdateSourceApiAssociationCommand.ts @@ -72,18 +72,19 @@ export interface UpdateSourceApiAssociationCommandOutput extends UpdateSourceApi * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/UpdateTypeCommand.ts b/clients/client-appsync/src/commands/UpdateTypeCommand.ts index 128731af343c..bf3cf8486a26 100644 --- a/clients/client-appsync/src/commands/UpdateTypeCommand.ts +++ b/clients/client-appsync/src/commands/UpdateTypeCommand.ts @@ -62,18 +62,19 @@ export interface UpdateTypeCommandOutput extends UpdateTypeResponse, __MetadataB * @see {@link AppSyncClientResolvedConfig | config} for AppSyncClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* * @throws {@link ConcurrentModificationException} (client fault) - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* * @throws {@link InternalFailureException} (server fault) *An internal AppSync error occurred. Try your request again.
* * @throws {@link NotFoundException} (client fault) - *The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* * @throws {@link UnauthorizedException} (client fault) *You aren't authorized to perform this operation.
diff --git a/clients/client-appsync/src/commands/index.ts b/clients/client-appsync/src/commands/index.ts index 5a0c97f80fea..278c26d23fd3 100644 --- a/clients/client-appsync/src/commands/index.ts +++ b/clients/client-appsync/src/commands/index.ts @@ -3,7 +3,9 @@ export * from "./AssociateApiCommand"; export * from "./AssociateMergedGraphqlApiCommand"; export * from "./AssociateSourceGraphqlApiCommand"; export * from "./CreateApiCacheCommand"; +export * from "./CreateApiCommand"; export * from "./CreateApiKeyCommand"; +export * from "./CreateChannelNamespaceCommand"; export * from "./CreateDataSourceCommand"; export * from "./CreateDomainNameCommand"; export * from "./CreateFunctionCommand"; @@ -11,7 +13,9 @@ export * from "./CreateGraphqlApiCommand"; export * from "./CreateResolverCommand"; export * from "./CreateTypeCommand"; export * from "./DeleteApiCacheCommand"; +export * from "./DeleteApiCommand"; export * from "./DeleteApiKeyCommand"; +export * from "./DeleteChannelNamespaceCommand"; export * from "./DeleteDataSourceCommand"; export * from "./DeleteDomainNameCommand"; export * from "./DeleteFunctionCommand"; @@ -26,6 +30,8 @@ export * from "./EvaluateMappingTemplateCommand"; export * from "./FlushApiCacheCommand"; export * from "./GetApiAssociationCommand"; export * from "./GetApiCacheCommand"; +export * from "./GetApiCommand"; +export * from "./GetChannelNamespaceCommand"; export * from "./GetDataSourceCommand"; export * from "./GetDataSourceIntrospectionCommand"; export * from "./GetDomainNameCommand"; @@ -38,6 +44,8 @@ export * from "./GetSchemaCreationStatusCommand"; export * from "./GetSourceApiAssociationCommand"; export * from "./GetTypeCommand"; export * from "./ListApiKeysCommand"; +export * from "./ListApisCommand"; +export * from "./ListChannelNamespacesCommand"; export * from "./ListDataSourcesCommand"; export * from "./ListDomainNamesCommand"; export * from "./ListFunctionsCommand"; @@ -55,7 +63,9 @@ export * from "./StartSchemaMergeCommand"; export * from "./TagResourceCommand"; export * from "./UntagResourceCommand"; export * from "./UpdateApiCacheCommand"; +export * from "./UpdateApiCommand"; export * from "./UpdateApiKeyCommand"; +export * from "./UpdateChannelNamespaceCommand"; export * from "./UpdateDataSourceCommand"; export * from "./UpdateDomainNameCommand"; export * from "./UpdateFunctionCommand"; diff --git a/clients/client-appsync/src/index.ts b/clients/client-appsync/src/index.ts index 718ec9da5b5a..c5e5e99c5478 100644 --- a/clients/client-appsync/src/index.ts +++ b/clients/client-appsync/src/index.ts @@ -1,8 +1,8 @@ // smithy-typescript generated code /* eslint-disable */ /** - *AppSync provides API actions for creating and interacting with data sources using GraphQL - * from your application.
+ *AppSync provides API actions for creating and interacting with data + * sources using GraphQL from your application.
* * @packageDocumentation */ diff --git a/clients/client-appsync/src/models/models_0.ts b/clients/client-appsync/src/models/models_0.ts index 199747a5b97a..1c2996e42264 100644 --- a/clients/client-appsync/src/models/models_0.ts +++ b/clients/client-appsync/src/models/models_0.ts @@ -41,39 +41,43 @@ export const AuthenticationType = { export type AuthenticationType = (typeof AuthenticationType)[keyof typeof AuthenticationType]; /** - *A LambdaAuthorizerConfig specifies how to authorize AppSync API access when
- * using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only
- * one Lambda authorizer configured at a time.
A LambdaAuthorizerConfig specifies how to authorize AppSync
+ * API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a
+ * time.
The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If
- * you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum
- * value is one hour (3600 seconds). The Lambda function can override this by returning a
- * ttlOverride key in its response.
The number of seconds a response should be cached for. The default is 0 seconds, which
+ * disables caching. If you don't specify a value for
+ * authorizerResultTtlInSeconds, the default value is used. The maximum value
+ * is one hour (3600 seconds). The Lambda function can override this by returning
+ * a ttlOverride key in its response.
The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can
- * be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.
The Amazon Resource Name (ARN) of the Lambda function to be called for
+ * authorization. This can be a standard Lambda ARN, a version ARN
+ * (.../v3), or an alias ARN.
- * Note: This Lambda function must have the following - * resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is - * done for you. To use the Command Line Interface (CLI), run the following:
+ * Note: This Lambda function must have the + * following resource-based policy assigned to it. When configuring Lambda + * authorizers in the console, this is done for you. To use the Command Line Interface + * (CLI), run the following: *
* aws lambda add-permission --function-name
- * "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal
- * appsync.amazonaws.com --action lambda:InvokeFunction
+ * "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync"
+ * --principal appsync.amazonaws.com --action lambda:InvokeFunction
*
A regular expression for validation of tokens before the Lambda function is called.
+ *A regular expression for validation of tokens before the Lambda function is + * called.
* @public */ identityValidationExpression?: string; @@ -85,16 +89,17 @@ export interface LambdaAuthorizerConfig { */ export interface OpenIDConnectConfig { /** - *The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of
- * iss in the ID token.
The issuer for the OIDC configuration. The issuer returned by discovery must exactly
+ * match the value of iss in the ID token.
The client identifier of the relying party at the OpenID identity provider. This identifier is typically - * obtained when the relying party is registered with the OpenID identity provider. You can specify a regular - * expression so that AppSync can validate against multiple client identifiers at a time.
+ *The client identifier of the relying party at the OpenID identity provider. This + * identifier is typically obtained when the relying party is registered with the OpenID + * identity provider. You can specify a regular expression so that AppSync can + * validate against multiple client identifiers at a time.
* @public */ clientId?: string; @@ -130,8 +135,8 @@ export interface CognitoUserPoolConfig { awsRegion: string | undefined; /** - *A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value - * isn't set, no filtering is applied.
+ *A regular expression for validating the incoming Amazon Cognito user pool app client + * ID. If this value isn't set, no filtering is applied.
* @public */ appIdClientRegex?: string; @@ -143,8 +148,8 @@ export interface CognitoUserPoolConfig { */ export interface AdditionalAuthenticationProvider { /** - *The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), - * Amazon Cognito user pools, or Lambda.
+ *The authentication type: API key, Identity and Access Management (IAM), OpenID + * Connect (OIDC), Amazon Cognito user pools, or Lambda.
* @public */ authenticationType?: AuthenticationType; @@ -168,6 +173,221 @@ export interface AdditionalAuthenticationProvider { lambdaAuthorizerConfig?: LambdaAuthorizerConfig; } +/** + *Describes an Amazon Cognito configuration.
+ * @public + */ +export interface CognitoConfig { + /** + *The user pool ID.
+ * @public + */ + userPoolId: string | undefined; + + /** + *The Amazon Web Services Region in which the user pool was created.
+ * @public + */ + awsRegion: string | undefined; + + /** + *A regular expression for validating the incoming Amazon Cognito user pool app client + * ID. If this value isn't set, no filtering is applied.
+ * @public + */ + appIdClientRegex?: string; +} + +/** + *Describes an authorization provider.
+ * @public + */ +export interface AuthProvider { + /** + *The authorization type.
+ * @public + */ + authType: AuthenticationType | undefined; + + /** + *Describes an Amazon Cognito user pool configuration.
+ * @public + */ + cognitoConfig?: CognitoConfig; + + /** + *Describes an OpenID Connect (OIDC) configuration.
+ * @public + */ + openIDConnectConfig?: OpenIDConnectConfig; + + /** + *A LambdaAuthorizerConfig specifies how to authorize AppSync
+ * API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a
+ * time.
Describes an authorization configuration. Use AuthMode to specify the
+ * publishing and subscription authorization configuration for an Event API.
The authorization type.
+ * @public + */ + authType: AuthenticationType | undefined; +} + +/** + * @public + * @enum + */ +export const EventLogLevel = { + ALL: "ALL", + DEBUG: "DEBUG", + ERROR: "ERROR", + INFO: "INFO", + NONE: "NONE", +} as const; + +/** + * @public + */ +export type EventLogLevel = (typeof EventLogLevel)[keyof typeof EventLogLevel]; + +/** + *Describes the CloudWatch Logs configuration for the Event API.
+ * @public + */ +export interface EventLogConfig { + /** + *The type of information to log for the Event API.
+ * @public + */ + logLevel: EventLogLevel | undefined; + + /** + *The IAM service role that AppSync assumes to publish CloudWatch Logs in your account.
+ * @public + */ + cloudWatchLogsRoleArn: string | undefined; +} + +/** + *Describes the authorization configuration for connections, message publishing, message + * subscriptions, and logging for an Event API.
+ * @public + */ +export interface EventConfig { + /** + *A list of authorization providers.
+ * @public + */ + authProviders: AuthProvider[] | undefined; + + /** + *A list of valid authorization modes for the Event API connections.
+ * @public + */ + connectionAuthModes: AuthMode[] | undefined; + + /** + *A list of valid authorization modes for the Event API publishing.
+ * @public + */ + defaultPublishAuthModes: AuthMode[] | undefined; + + /** + *A list of valid authorization modes for the Event API subscriptions.
+ * @public + */ + defaultSubscribeAuthModes: AuthMode[] | undefined; + + /** + *The CloudWatch Logs configuration for the Event API.
+ * @public + */ + logConfig?: EventLogConfig; +} + +/** + *Describes an AppSync API. You can use Api for an AppSync
+ * API with your preferred configuration, such as an Event API that provides real-time message
+ * publishing and message subscriptions over WebSockets.
The Api ID.
The name of the Api.
The owner contact information for the Api
+ *
A map with keys of TagKey objects and values of TagValue
+ * objects.
The DNS records for the API. This will include an HTTP and a real-time endpoint.
+ * @public + */ + dns?: RecordThe Amazon Resource Name (ARN) for the Api.
The date and time that the Api was created.
A flag indicating whether to use X-Ray tracing for this
+ * Api.
The Amazon Resource Name (ARN) of the WAF web access control list (web
+ * ACL) associated with this Api, if one exists.
The Event API configuration. This includes the default authorization configuration for + * connecting, publishing, and subscribing to an Event API.
+ * @public + */ + eventConfig?: EventConfig; +} + /** * @public * @enum @@ -205,18 +425,18 @@ export interface ApiAssociation { *- * PROCESSING: The API association is being created. You cannot - * modify association requests during processing.
+ * PROCESSING: The API association is being + * created. You cannot modify association requests during processing. *- * SUCCESS: The API association was successful. You can modify - * associations after success.
+ * SUCCESS: The API association was successful. + * You can modify associations after success. *- * FAILED: The API association has failed. You can modify - * associations after failure.
+ * FAILED: The API association has failed. You + * can modify associations after failure. *- * FULL_REQUEST_CACHING: All requests are fully cached.
+ * FULL_REQUEST_CACHING: All requests are fully + * cached. *- * PER_RESOLVER_CACHING: Individual resolvers that you specify are - * cached.
+ * PER_RESOLVER_CACHING: Individual resolvers + * that you specify are cached. *Transit encryption flag when connecting to cache. You cannot update this setting after creation.
+ *Transit encryption flag when connecting to cache. You cannot update this setting after + * creation.
* @public */ transitEncryptionEnabled?: boolean; @@ -427,23 +649,28 @@ export interface ApiCache { *- * AVAILABLE: The instance is available for use.
+ * AVAILABLE: The instance is available for + * use. *- * CREATING: The instance is currently creating.
+ * CREATING: The instance is currently + * creating. *- * DELETING: The instance is currently deleting.
+ * DELETING: The instance is currently + * deleting. *- * MODIFYING: The instance is currently modifying.
+ * MODIFYING: The instance is currently + * modifying. *- * FAILED: The instance has failed creation.
+ * FAILED: The instance has failed + * creation. *Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
+ *Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics + * include:
*NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded - * the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache - * configuration.
+ *NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the + * throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing + * bottlenecks in a cache configuration.
*EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is - * useful for diagnosing bottlenecks in a cache configuration.
+ *EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis + * process. This is useful for diagnosing bottlenecks in a cache + * configuration.
*Metrics will be recorded by API ID. You can set the value to ENABLED or
- * DISABLED.
DISABLED.
* @public
*/
healthMetricsConfig?: CacheHealthMetricsConfig;
@@ -472,12 +701,13 @@ export interface ApiCache {
/**
* Describes an API key.
- *Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism. - * There are two key versions:
+ *Customers invoke AppSync GraphQL API operations with API keys as an + * identity mechanism. There are two key versions:
*- * da1: We introduced this version at launch in November 2017. These keys - * always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid - * after February 21, 2018, and they should no longer be used.
+ * da1: We introduced this version at launch in November + * 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key + * expiration. These keys ceased to be valid after February 21, 2018, and they should no + * longer be used. *@@ -485,7 +715,8 @@ export interface ApiCache { *
- * CreateApiKey returns the expiration time in milliseconds.
CreateApiKey returns the expiration time in
+ * milliseconds.
*
@@ -496,40 +727,45 @@ export interface ApiCache {
* DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are - * not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a - * one-time action, we deleted these keys from the table on February 21, 2018.
+ *Expiration is stored in DynamoDB as milliseconds. This results in a + * bug where keys are not automatically deleted because DynamoDB expects the + * TTL to be stored in seconds. As a one-time action, we deleted these keys from the + * table on February 21, 2018.
*- * da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.
+ * da2: We introduced this version in February 2018 when + * AppSync added support to extend key expiration. *
- * ListApiKeys returns the expiration time and deletion time in seconds.
ListApiKeys returns the expiration time and deletion time in
+ * seconds.
*
- * CreateApiKey returns the expiration time and deletion time in seconds and accepts a
- * user-provided expiration time in seconds.
CreateApiKey returns the expiration time and deletion time in
+ * seconds and accepts a user-provided expiration time in seconds.
*
- * UpdateApiKey returns the expiration time and and deletion time in seconds and accepts
- * a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration
- * time. You can update the key expiration time as long as the key isn't deleted.
UpdateApiKey returns the expiration time and and deletion time in
+ * seconds and accepts a user-provided expiration time in seconds. Expired API keys are
+ * kept for 60 days after the expiration time. You can update the key expiration time as
+ * long as the key isn't deleted.
*
* DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to - * authenticate will fail. However, you can reinstate the key before deletion.
+ *Expiration is stored in DynamoDB as seconds. After the expiration + * time, using the key to authenticate will fail. However, you can reinstate the key + * before deletion.
*Deletion is stored in DynamoDB as seconds. The key is deleted after deletion - * time.
+ *Deletion is stored in DynamoDB as seconds. The key is deleted after + * deletion time.
*The time after which the API key expires. The date is represented as seconds since the epoch, rounded down - * to the nearest hour.
+ *The time after which the API key expires. The date is represented as seconds since the + * epoch, rounded down to the nearest hour.
* @public */ expires?: number; /** - *The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded - * down to the nearest hour.
+ *The time after which the API key is deleted. The date is represented as seconds since + * the epoch, rounded down to the nearest hour.
* @public */ deletes?: number; @@ -637,22 +873,21 @@ export const RuntimeName = { export type RuntimeName = (typeof RuntimeName)[keyof typeof RuntimeName]; /** - *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 that if a runtime is specified, code must - * also be specified.
+ *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 + * that if a runtime is specified, code must also be specified.
* @public */ export interface AppSyncRuntime { /** *The name of the runtime to use. Currently, the only allowed value is
- * APPSYNC_JS.
APPSYNC_JS.
* @public
*/
name: RuntimeName | undefined;
/**
* The version of the runtime to use. Currently, the only allowed version is
- * 1.0.0.
1.0.0.
* @public
*/
runtimeVersion: string | undefined;
@@ -717,14 +952,16 @@ export interface CodeErrorLocation {
export interface CodeError {
/**
* The type of code error.
- *Examples include, but aren't limited to: LINT_ERROR, PARSER_ERROR.
Examples include, but aren't limited to: LINT_ERROR,
+ * PARSER_ERROR.
A user presentable error.
- *Examples include, but aren't limited to: Parsing error: Unterminated string literal.
Examples include, but aren't limited to: Parsing error: Unterminated string
+ * literal.
Provides further details for the reason behind the bad request. For reason type CODE_ERROR, the
- * detail will contain a list of code errors.
Provides further details for the reason behind the bad request. For reason type
+ * CODE_ERROR, the detail will contain a list of code errors.
The request is not well formed. For example, a value is invalid or a required field is missing. Check the - * field values, and then try again.
+ *The request is not well formed. For example, a value is invalid or a required field is + * missing. Check the field values, and then try again.
* @public */ export class BadRequestException extends __BaseException { @@ -772,14 +1009,14 @@ export class BadRequestException extends __BaseException { readonly $fault: "client" = "client"; /** *Provides context for the cause of the bad request. The only supported value is
- * CODE_ERROR.
CODE_ERROR.
* @public
*/
reason?: BadRequestReason;
/**
- * Provides further details for the reason behind the bad request. For reason type CODE_ERROR, the
- * detail will contain a list of code errors.
Provides further details for the reason behind the bad request. For reason type
+ * CODE_ERROR, the detail will contain a list of code errors.
The resource specified in the request was not found. Check the resource, and then try again.
+ *The resource specified in the request was not found. Check the resource, and then try + * again.
* @public */ export class NotFoundException extends __BaseException { @@ -859,12 +1097,14 @@ export type MergeType = (typeof MergeType)[keyof typeof MergeType]; */ export interface SourceApiAssociationConfig { /** - *The property that indicates which merging option is enabled in the source API association.
- *Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the
- * default behavior and require the user to trigger any changes from the source APIs to the merged API manually.
- * Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the
- * source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform
- * merge operations.
The property that indicates which merging option is enabled in the source API + * association.
+ *Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE.
+ * Manual merges are the default behavior and require the user to trigger any changes from the
+ * source APIs to the merged API manually. Auto merges subscribe the merged API to the changes
+ * performed on the source APIs so that any change in the source APIs are also made to the
+ * merged API. Auto merges use MergedApiExecutionRoleArn to perform merge
+ * operations.
The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source - * APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs - * from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
+ *The identifier of the AppSync Source API. This is generated by the AppSync service. In + * most cases, source APIs (especially in your account) only require the API ID value or ARN + * of the source API. However, source APIs from other accounts (cross-account use cases) + * strictly require the full resource ARN of the source API.
* @public */ sourceApiIdentifier: string | undefined; /** - *The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged - * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs - * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
+ *The identifier of the AppSync Merged API. This is generated by the AppSync service. In + * most cases, Merged APIs (especially in your account) only require the API ID value or ARN + * of the merged API. However, Merged APIs in other accounts (cross-account use cases) + * strictly require the full resource ARN of the merged API.
* @public */ mergedApiIdentifier: string | undefined; @@ -924,13 +1166,12 @@ export const SourceApiAssociationStatus = { export type SourceApiAssociationStatus = (typeof SourceApiAssociationStatus)[keyof typeof SourceApiAssociationStatus]; /** - *Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API. - * There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's - * schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular - * API.
- *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 accounts, see What is Amazon Web Services Resource - * Access Manager? in the Amazon Web Services Resource Access Manager guide.
+ *Describes the configuration of a source API. A source API is a GraphQL API that is + * linked to a merged API. There can be multiple source APIs attached to each merged API. When + * linked to a merged API, the source API's schema, data sources, and resolvers will be + * combined with other linked source API data to form a new, singular API.
+ *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 + * accounts, see What is Amazon Web Services Resource Access Manager? in the Amazon Web Services Resource Access Manager guide.
* @public */ export interface SourceApiAssociation { @@ -995,8 +1236,8 @@ export interface SourceApiAssociation { sourceApiAssociationStatusDetail?: string; /** - *The datetime value of the last successful merge of the source API association. The result will be in UTC - * format and your local time zone.
+ *The datetime value of the last successful merge of the source API association. The + * result will be in UTC format and your local time zone.
* @public */ lastSuccessfulMergeDate?: Date; @@ -1014,8 +1255,8 @@ export interface AssociateMergedGraphqlApiResponse { } /** - *Another modification is in progress at this time and it must complete before you can make your - * change.
+ *Another modification is in progress at this time and it must complete before you can + * make your change.
* @public */ export class ConcurrentModificationException extends __BaseException { @@ -1079,17 +1320,19 @@ export class UnauthorizedException extends __BaseException { */ export interface AssociateSourceGraphqlApiRequest { /** - *The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged - * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs - * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
+ *The identifier of the AppSync Merged API. This is generated by the AppSync service. In + * most cases, Merged APIs (especially in your account) only require the API ID value or ARN + * of the merged API. However, Merged APIs in other accounts (cross-account use cases) + * strictly require the full resource ARN of the merged API.
* @public */ mergedApiIdentifier: string | undefined; /** - *The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source - * APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs - * from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
+ *The identifier of the AppSync Source API. This is generated by the AppSync service. In + * most cases, source APIs (especially in your account) only require the API ID value or ARN + * of the source API. However, source APIs from other accounts (cross-account use cases) + * strictly require the full resource ARN of the source API.
* @public */ sourceApiIdentifier: string | undefined; @@ -1159,8 +1402,8 @@ export interface AuthorizationConfig { *- * AWS_IAM: The authorization type is Signature Version 4 - * (SigV4).
+ * AWS_IAM: The authorization type is Signature + * Version 4 (SigV4). *The name for the Api.
The owner contact information for the Api.
A map with keys of TagKey objects and values of TagValue
+ * objects.
The Event API configuration. This includes the default authorization configuration for + * connecting, publishing, and subscribing to an Event API.
+ * @public + */ + eventConfig?: EventConfig; +} + +/** + * @public + */ +export interface CreateApiResponse { + /** + *The Api object.
The operation exceeded the service quota for this resource.
+ * @public + */ +export class ServiceQuotaExceededException extends __BaseException { + readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeRepresents the input of a CreateApiCache operation.
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
+ *Transit encryption flag when connecting to cache. You cannot update this setting after + * creation.
* @public */ transitEncryptionEnabled?: boolean; @@ -1209,12 +1515,13 @@ export interface CreateApiCacheRequest { *- * FULL_REQUEST_CACHING: All requests are fully cached.
+ * FULL_REQUEST_CACHING: All requests are fully + * cached. *- * PER_RESOLVER_CACHING: Individual resolvers that you specify are - * cached.
+ * PER_RESOLVER_CACHING: Individual resolvers + * that you specify are cached. *Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
+ *Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics + * include:
*NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded - * the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache - * configuration.
+ *NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the + * throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing + * bottlenecks in a cache configuration.
*EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is - * useful for diagnosing bottlenecks in a cache configuration.
+ *EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis + * process. This is useful for diagnosing bottlenecks in a cache + * configuration.
*Metrics will be recorded by API ID. You can set the value to ENABLED or
- * DISABLED.
DISABLED.
+ * @public
+ */
+ healthMetricsConfig?: CacheHealthMetricsConfig;
+}
+
+/**
+ * Represents the output of a CreateApiCache operation.
The ApiCache object.
The ID for your GraphQL API.
+ * @public + */ + apiId: string | undefined; + + /** + *A description of the purpose of the API key.
+ * @public + */ + description?: string; + + /** + *From the creation time, the time after which the API key expires. The date is + * represented as seconds since the epoch, rounded down to the nearest hour. The default value + * for this parameter is 7 days from creation time. For more information, see .
+ * @public + */ + expires?: number; +} + +/** + * @public + */ +export interface CreateApiKeyResponse { + /** + *The API key.
+ * @public + */ + apiKey?: ApiKey; +} + +/** + *A conflict with a previous successful update is detected. This typically + * occurs when the previous update did not have time to propagate before the next update was + * made. A retry (with appropriate backoff logic) is the recommended response to this + * exception.
+ * @public + */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe Api ID.
The name of the ChannelNamespace. This name must be unique within the
+ * Api
+ *
The authorization mode to use for subscribing to messages on the channel namespace. This
+ * configuration overrides the default Api authorization configuration.
The authorization mode to use for publishing messages on the channel namespace. This
+ * configuration overrides the default Api authorization configuration.
The event handler functions that run custom business logic to process published events + * and subscribe requests.
+ * @public + */ + codeHandlers?: string; + + /** + *A map with keys of TagKey objects and values of TagValue
+ * objects.
Describes a channel namespace associated with an Api. The ChannelNamespace contains the definitions for code handlers for the Api.
The Api ID.
The name of the channel namespace. This name must be unique within the
+ * Api.
The authorization mode to use for subscribing to messages on the channel namespace. This
+ * configuration overrides the default Apiauthorization configuration.
The authorization mode to use for publishing messages on the channel namespace. This
+ * configuration overrides the default Apiauthorization configuration.
The event handler functions that run custom business logic to process published events + * and subscribe requests.
* @public */ - healthMetricsConfig?: CacheHealthMetricsConfig; -} + codeHandlers?: string; -/** - *Represents the output of a CreateApiCache operation.
The ApiCache object.
A map with keys of TagKey objects and values of TagValue
+ * objects.
The ID for your GraphQL API.
+ *The Amazon Resource Name (ARN) for the ChannelNamespace.
A description of the purpose of the API key.
+ *The date and time that the ChannelNamespace was created.
From the creation time, the time after which the API key expires. The date is represented as seconds since - * the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. - * For more information, see .
+ *The date and time that the ChannelNamespace was last changed.
The API key.
+ *The ChannelNamespace object.
The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
+ *The number of minutes that a Delta Sync log entry is stored in the Delta Sync + * table.
* @public */ deltaSyncTableTTL?: number; @@ -1430,8 +1886,9 @@ export interface DynamodbDataSourceConfig { /** *Describes an OpenSearch data source configuration.
- *As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is - * deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source.
+ *As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This + * configuration is deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data + * source.
* @public */ export interface ElasticsearchDataSourceConfig { @@ -1454,8 +1911,8 @@ export interface ElasticsearchDataSourceConfig { */ export interface EventBridgeDataSourceConfig { /** - *The ARN of the event bus. For more information about event buses, see Amazon EventBridge event - * buses.
+ *The ARN of the event bus. For more information about event buses, see Amazon + * EventBridge event buses.
* @public */ eventBusArn: string | undefined; @@ -1467,9 +1924,10 @@ export interface EventBridgeDataSourceConfig { */ export interface HttpDataSourceConfig { /** - *The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL - * scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 - * for the HTTP endpoint and port 443 for HTTPS endpoints.
+ *The HTTP URL endpoint. You can specify either the domain name or IP, and port + * combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port, + * AppSync uses the default port 80 for the HTTP endpoint and port 443 for + * HTTPS endpoints.
* @public */ endpoint?: string; @@ -1556,7 +2014,8 @@ export interface RdsHttpEndpointConfig { schema?: string; /** - *Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.
+ *Amazon Web Services secret store Amazon Resource Name (ARN) for database + * credentials.
* @public */ awsSecretStoreArn?: string; @@ -1586,8 +2045,9 @@ export interface RelationalDatabaseDataSourceConfig { *- * RDS_HTTP_ENDPOINT: The relational database source type is an - * Amazon Relational Database Service (Amazon RDS) HTTP endpoint.
+ * RDS_HTTP_ENDPOINT: The relational database + * source type is an Amazon Relational Database Service (Amazon RDS) HTTP + * endpoint. *The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. - * The system assumes this role when accessing the data source.
+ *The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) + * for the data source. The system assumes this role when accessing the data source.
* @public */ serviceRoleArn?: string; @@ -1670,9 +2130,8 @@ export interface CreateDataSourceRequest { /** *Amazon OpenSearch Service settings.
- *As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is - * deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to - * create an OpenSearch data source.
+ *As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This + * configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.
* @public */ elasticsearchConfig?: ElasticsearchDataSourceConfig; @@ -1703,10 +2162,11 @@ export interface CreateDataSourceRequest { /** *Enables or disables enhanced data source metrics for specified data sources. Note that
- * metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set
- * to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to
- * FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,
- * you can still set its value.
metricsConfig won't be used unless the
+ * dataSourceLevelMetricsBehavior value is set to
+ * PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior
+ * is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig
+ * will be ignored. However, you can still set its value.
*
* metricsConfig can be ENABLED or DISABLED.
- * AWS_LAMBDA: The data source is an Lambda - * function.
+ * AWS_LAMBDA: The data source is an Lambda function. *- * AMAZON_DYNAMODB: The data source is an Amazon DynamoDB - * table.
+ * AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table. *- * AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service - * domain.
+ * AMAZON_ELASTICSEARCH: The data source is an + * Amazon OpenSearch Service domain. *- * AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
+ * AMAZON_OPENSEARCH_SERVICE: The data source is + * an Amazon OpenSearch Service domain. *- * AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge - * configuration.
+ * AMAZON_EVENTBRIDGE: The data source is an + * Amazon EventBridge configuration. *- * NONE: There is no data source. Use this type when you want to - * invoke a GraphQL operation without connecting to a data source, such as when you're performing data - * transformation with resolvers or invoking a subscription from a mutation.
+ * NONE: There is no data source. Use this type + * when you want to invoke a GraphQL operation without connecting to a data source, such + * as when you're performing data transformation with resolvers or invoking a + * subscription from a mutation. *- * HTTP: The data source is an HTTP endpoint.
+ * HTTP: The data source is an HTTP + * endpoint. *- * RELATIONAL_DATABASE: The data source is a relational - * database.
+ * RELATIONAL_DATABASE: The data source is a + * relational database. *The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. - * The system assumes this role when accessing the data source.
+ *The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) + * for the data source. The system assumes this role when accessing the data source.
* @public */ serviceRoleArn?: string; @@ -1835,10 +2296,11 @@ export interface DataSource { /** *Enables or disables enhanced data source metrics for specified data sources. Note that
- * metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set
- * to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to
- * FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,
- * you can still set its value.
metricsConfig won't be used unless the
+ * dataSourceLevelMetricsBehavior value is set to
+ * PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior
+ * is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig
+ * will be ignored. However, you can still set its value.
*
* metricsConfig can be ENABLED or DISABLED.
The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
+ *The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager + * (ACM) certificate or an Identity and Access Management (IAM) + * server certificate.
* @public */ certificateArn: string | undefined; @@ -1898,7 +2362,9 @@ export interface DomainNameConfig { description?: string; /** - *The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
+ *The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager + * (ACM) certificate or an Identity and Access Management (IAM) + * server certificate.
* @public */ certificateArn?: string; @@ -1958,13 +2424,14 @@ export const ConflictHandlerType = { export type ConflictHandlerType = (typeof ConflictHandlerType)[keyof typeof ConflictHandlerType]; /** - *The LambdaConflictHandlerConfig object when configuring LAMBDA as the Conflict
- * Handler.
The LambdaConflictHandlerConfig object when configuring LAMBDA
+ * as the Conflict Handler.
The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
+ *The Amazon Resource Name (ARN) for the Lambda function to use as the + * Conflict Handler.
* @public */ lambdaConflictHandlerArn?: string; @@ -1972,8 +2439,8 @@ export interface LambdaConflictHandlerConfig { /** *Describes a Sync configuration for a resolver.
- *Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is - * invoked.
+ *Specifies which Conflict Detection strategy and Resolution strategy to use when the + * resolver is invoked.
* @public */ export interface SyncConfig { @@ -1982,18 +2449,19 @@ export interface SyncConfig { *- * OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations - * when versions don't match the latest version at the server.
+ * OPTIMISTIC_CONCURRENCY: Resolve conflicts by + * rejecting mutations when versions don't match the latest version at the + * server. *- * AUTOMERGE: Resolve conflicts with the Automerge conflict - * resolution strategy.
+ * AUTOMERGE: Resolve conflicts with the + * Automerge conflict resolution strategy. *
- * LAMBDA: Resolve conflicts with an Lambda function
- * supplied in the LambdaConflictHandlerConfig.
LambdaConflictHandlerConfig.
* - * VERSION: Detect conflicts based on object versions for this - * resolver.
+ * VERSION: Detect conflicts based on object + * versions for this resolver. *- * NONE: Do not detect conflicts when invoking this - * resolver.
+ * NONE: Do not detect conflicts when invoking + * this resolver. *The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict
- * Handler.
The LambdaConflictHandlerConfig when configuring LAMBDA as the
+ * Conflict Handler.
The Function request mapping template. Functions support only the 2018-05-29 version of the
- * request mapping template.
The Function request mapping template. Functions support only the
+ * 2018-05-29 version of the request mapping template.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note
- * that when using VTL and mapping templates, the functionVersion is required.
The version of the request mapping template. Currently, the supported value
+ * is 2018-05-29. Note that when using VTL and mapping templates, the
+ * functionVersion is required.
Describes a Sync configuration for a resolver.
- *Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is - * invoked.
+ *Specifies which Conflict Detection strategy and Resolution strategy to use when the + * resolver is invoked.
* @public */ syncConfig?: SyncConfig; @@ -2090,23 +2559,24 @@ export interface CreateFunctionRequest { maxBatchSize?: number; /** - *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 that if a runtime is specified, code must - * also be specified.
+ *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 + * that if a runtime is specified, code must also be specified.
* @public */ runtime?: AppSyncRuntime; /** - *The function code that contains the request and response functions. When code is used, the
- * runtime is required. The runtime value must be APPSYNC_JS.
The function code that contains the request and response functions. When
+ * code is used, the runtime is required. The runtime value must be
+ * APPSYNC_JS.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
+ *A function is a reusable entity. You can use multiple functions to compose the resolver + * logic.
* @public */ export interface FunctionConfiguration { @@ -2141,8 +2611,8 @@ export interface FunctionConfiguration { dataSourceName?: string; /** - *The Function request mapping template. Functions support only the 2018-05-29 version of the
- * request mapping template.
The Function request mapping template. Functions support only the
+ * 2018-05-29 version of the request mapping template.
The version of the request mapping template. Currently, only the 2018-05-29 version of the template is - * supported.
+ *The version of the request mapping template. Currently, only the 2018-05-29 version of + * the template is supported.
* @public */ functionVersion?: string; /** *Describes a Sync configuration for a resolver.
- *Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is - * invoked.
+ *Specifies which Conflict Detection strategy and Resolution strategy to use when the + * resolver is invoked.
* @public */ syncConfig?: SyncConfig; @@ -2175,16 +2645,16 @@ export interface FunctionConfiguration { maxBatchSize?: number; /** - *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 that if a runtime is specified, code must - * also be specified.
+ *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 + * that if a runtime is specified, code must also be specified.
* @public */ runtime?: AppSyncRuntime; /** - *The function code that contains the request and response functions. When code is used, the
- * runtime is required. The runtime value must be APPSYNC_JS.
The function code that contains the request and response functions. When
+ * code is used, the runtime is required. The runtime value must be
+ * APPSYNC_JS.
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and - * performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data - * is sent to your CloudWatch account, and you can configure the types of data that will be sent.
+ *Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data + * on API usage and performance such as AppSync request and error counts, latency, and cache + * hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can + * configure the types of data that will be sent.
*Enhanced metrics can be configured at the resolver, data source, and operation levels.
- * EnhancedMetricsConfig contains three required parameters, each controlling one of these
- * categories:
EnhancedMetricsConfig contains three required parameters, each controlling
+ * one of these categories:
*
- * resolverLevelMetricsBehavior: Controls how resolver metrics will be emitted to
- * CloudWatch. Resolver metrics include:
resolverLevelMetricsBehavior: Controls how resolver metrics will
+ * be emitted to CloudWatch. Resolver metrics include:
* GraphQL errors: The number of GraphQL errors that occurred.
*Requests: The number of invocations that occurred during a request.
+ *Requests: The number of invocations that occurred during a request. + *
*Latency: The time to complete a resolver invocation.
@@ -2289,75 +2761,83 @@ export type ResolverLevelMetricsBehavior = *Cache misses: The number of cache misses during a request.
*These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics
- * will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of
- * these values at a time:
These metrics can be emitted to CloudWatch per resolver or for all resolvers in
+ * the request. Metrics will be recorded by API ID and resolver name.
+ * resolverLevelMetricsBehavior accepts one of these values at a
+ * time:
- * FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers
- * in the request.
FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data
+ * for all resolvers in the request.
*
- * PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the
- * metricsConfig value set to ENABLED.
PER_RESOLVER_METRICS: Records and emits metric data for
+ * resolvers that have the metricsConfig value set to
+ * ENABLED.
*
- * dataSourceLevelMetricsBehavior: Controls how data source metrics will be emitted to
- * CloudWatch. Data source metrics include:
dataSourceLevelMetricsBehavior: Controls how data source metrics
+ * will be emitted to CloudWatch. Data source metrics include:
* Requests: The number of invocations that occured during a request.
+ *Requests: The number of invocations that occured during a + * request.
*Latency: The time to complete a data source invocation.
*Errors: The number of errors that occurred during a data source invocation.
+ *Errors: The number of errors that occurred during a data source + * invocation.
*These metrics can be emitted to CloudWatch per data source or for all data sources in the request.
- * Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior
- * accepts one of these values at a time:
These metrics can be emitted to CloudWatch per data source or for all data sources
+ * in the request. Metrics will be recorded by API ID and data source name.
+ * dataSourceLevelMetricsBehavior accepts one of these values at a
+ * time:
- * FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data
- * sources in the request.
FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric
+ * data for all data sources in the request.
*
- * PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that
- * have the metricsConfig value set to ENABLED.
PER_DATA_SOURCE_METRICS: Records and emits metric data for
+ * data sources that have the metricsConfig value set to
+ * ENABLED.
*
- * operationLevelMetricsConfig: Controls how operation metrics will be emitted to
- * CloudWatch. Operation metrics include:
operationLevelMetricsConfig: Controls how operation metrics will
+ * be emitted to CloudWatch. Operation metrics include:
* Requests: The number of times a specified GraphQL operation was called.
+ *Requests: The number of times a specified GraphQL operation was + * called.
*GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL - * operation.
+ *GraphQL errors: The number of GraphQL errors that occurred during a + * specified GraphQL operation.
*Metrics will be recorded by API ID and operation name. You can set the value to ENABLED
- * or DISABLED.
Metrics will be recorded by API ID and operation name. You can set the value to
+ * ENABLED or DISABLED.
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
+ *Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics + * include:
*GraphQL errors: The number of GraphQL errors that occurred.
@@ -2375,19 +2855,19 @@ export interface EnhancedMetricsConfig { *Cache misses: The number of cache misses during a request.
*These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be
- * recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at
- * a time:
These metrics can be emitted to CloudWatch per resolver or for all resolvers in the
+ * request. Metrics will be recorded by API ID and resolver name.
+ * resolverLevelMetricsBehavior accepts one of these values at a time:
- * FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the
- * request.
FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for
+ * all resolvers in the request.
*
- * PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the
- * metricsConfig value set to ENABLED.
PER_RESOLVER_METRICS: Records and emits metric data for resolvers
+ * that have the metricsConfig value set to ENABLED.
* Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
+ *Controls how data source metrics will be emitted to CloudWatch. Data source metrics + * include:
*Requests: The number of invocations that occured during a request.
@@ -2404,22 +2885,25 @@ export interface EnhancedMetricsConfig { *Latency: The time to complete a data source invocation.
*Errors: The number of errors that occurred during a data source invocation.
+ *Errors: The number of errors that occurred during a data source + * invocation.
*These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics
- * will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of
- * these values at a time:
These metrics can be emitted to CloudWatch per data source or for all data sources in
+ * the request. Metrics will be recorded by API ID and data source name.
+ * dataSourceLevelMetricsBehavior accepts one of these values at a
+ * time:
- * FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources
- * in the request.
FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data
+ * for all data sources in the request.
*
- * PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the
- * metricsConfig value set to ENABLED.
PER_DATA_SOURCE_METRICS: Records and emits metric data for data
+ * sources that have the metricsConfig value set to
+ * ENABLED.
* Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
+ *Controls how operation metrics will be emitted to CloudWatch. Operation metrics + * include:
*Requests: The number of times a specified GraphQL operation was called.
+ *Requests: The number of times a specified GraphQL operation was + * called.
*GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL - * operation.
+ *GraphQL errors: The number of GraphQL errors that occurred during a specified + * GraphQL operation.
*Metrics will be recorded by API ID and operation name. You can set the value to ENABLED or
- * DISABLED.
Metrics will be recorded by API ID and operation name. You can set the value to
+ * ENABLED or DISABLED.
The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.
+ *The field logging level. Values can be NONE, ERROR, or ALL.
*- * NONE: No field-level logs are captured.
+ * NONE: No field-level logs are + * captured. *- * ERROR: Logs the following information - * only for the fields that are in the error - * category:
+ * ERROR: Logs the following information only for + * the fields that are in error: *The error section in the server response.
@@ -2501,56 +2987,21 @@ export interface LogConfig { *Field-level errors.
*The generated request/response functions that got resolved for error fields.
- *- * INFO: Logs the following information only for the fields that are in the info and error - * categories:
- *Info-level messages.
- *The user messages sent through $util.log.info and
- * console.log.
Field-level tracing and mapping logs are not shown.
- *- * DEBUG: Logs the following information - * only for the fields that are in the debug, info, - * and error categories:
- *Debug-level messages.
- *The user messages sent through $util.log.info,
- * $util.log.debug, console.log, and
- * console.debug.
Field-level tracing and mapping logs are not shown.
+ *The generated request/response functions that got resolved for error + * fields.
*- * ALL: The following information is logged for all fields in the - * query:
+ * ALL: The following information is logged for + * all fields in the query: *Field-level tracing information.
*The generated request/response functions that were resolved for each + *
The generated request/response functions that got resolved for each * field.
*The service role that AppSync assumes to publish to CloudWatch logs in your - * account.
+ *The service role that AppSync assumes to publish to CloudWatch + * logs in your account.
* @public */ cloudWatchLogsRoleArn: string | undefined; /** - *Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping - * templates, regardless of logging level.
+ *Set to TRUE to exclude sections that contain information such as headers, context, and + * evaluated mapping templates, regardless of logging level.
* @public */ excludeVerboseContent?: boolean; @@ -2607,15 +3058,15 @@ export interface UserPoolConfig { awsRegion: string | undefined; /** - *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 configuration.
+ *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 + * configuration.
* @public */ defaultAction: DefaultAction | undefined; /** - *A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value - * isn't set, no filtering is applied.
+ *A regular expression for validating the incoming Amazon Cognito user pool app client + * ID. If this value isn't set, no filtering is applied.
* @public */ appIdClientRegex?: string; @@ -2652,8 +3103,8 @@ export interface CreateGraphqlApiRequest { logConfig?: LogConfig; /** - *The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), - * Amazon Cognito user pools, or Lambda.
+ *The authentication type: API key, Identity and Access Management (IAM), OpenID + * Connect (OIDC), Amazon Cognito user pools, or Lambda.
* @public */ authenticationType: AuthenticationType | undefined; @@ -2677,13 +3128,15 @@ export interface CreateGraphqlApiRequest { tags?: RecordA list of additional authentication providers for the GraphqlApi API.
A list of additional authentication providers for the GraphqlApi
+ * API.
A flag indicating whether to use X-Ray tracing for the GraphqlApi.
A flag indicating whether to use X-Ray tracing for the
+ * GraphqlApi.
Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no
- * value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed
- * once the API has been created.
The value that indicates whether the GraphQL API is a standard API
+ * (GRAPHQL) or merged API (MERGED).
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API
- * (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync
+ * service assumes this role on behalf of the Merged API to validate access to source APIs at
+ * runtime and to prompt the AUTO_MERGE to update the merged API endpoint with
+ * the source API changes automatically.
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role
- * on behalf of the Merged API to validate access to source APIs at runtime and to prompt the
- * AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
Sets the value of the GraphQL API to public (GLOBAL) or private
+ * (PRIVATE). If no value is provided, the visibility will be set to
+ * GLOBAL by default. This value cannot be changed once the API has been
+ * created.
The owner contact information for an API resource.
@@ -2725,32 +3180,34 @@ export interface CreateGraphqlApiRequest { ownerContact?: string; /** - *Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)
- * introspection. If no value is provided, the introspection configuration will be set to ENABLED by
- * default. This field will produce an error if the operation attempts to use the introspection feature while this
- * field is disabled.
For more information about introspection, see GraphQL - * introspection.
+ *Sets the value of the GraphQL API to enable (ENABLED) or disable
+ * (DISABLED) introspection. If no value is provided, the introspection
+ * configuration will be set to ENABLED by default. This field will produce an
+ * error if the operation attempts to use the introspection feature while this field is
+ * disabled.
For more information about introspection, see GraphQL introspection.
* @public */ introspectionConfig?: GraphQLApiIntrospectionConfig; /** - *The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed
- * in the body of query. The default value is 0 (or unspecified), which indicates there's no depth
- * limit. If you set a limit, it can be between 1 and 75 nested levels. This field will
- * produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, - * the error will be thrown upwards to the first nullable field available.
+ *The maximum depth a query can have in a single request. Depth refers to the amount of
+ * nested levels allowed in the body of query. The default value is 0 (or
+ * unspecified), which indicates there's no depth limit. If you set a limit, it can be between
+ * 1 and 75 nested levels. This field will produce a limit error
+ * if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field + * produces an error, the error will be thrown upwards to the first nullable field + * available.
* @public */ queryDepthLimit?: number; /** - *The maximum number of resolvers that can be invoked in a single request. The default value is 0
- * (or unspecified), which will set the limit to 10000. When specified, the limit value can be
- * between 1 and 10000. This field will produce a limit error if the operation falls out
- * of bounds.
The maximum number of resolvers that can be invoked in a single request. The default
+ * value is 0 (or unspecified), which will set the limit to 10000.
+ * When specified, the limit value can be between 1 and 10000. This
+ * field will produce a limit error if the operation falls out of bounds.
A list of additional authentication providers for the GraphqlApi API.
A list of additional authentication providers for the GraphqlApi
+ * API.
A flag indicating whether to use X-Ray tracing for this GraphqlApi.
A flag indicating whether to use X-Ray tracing for this
+ * GraphqlApi.
The ARN of the WAF access control list (ACL) associated with this
- * GraphqlApi, if one exists.
GraphqlApi, if one exists.
* @public
*/
wafWebAclArn?: string;
@@ -2853,24 +3312,26 @@ export interface GraphqlApi {
dns?: RecordSets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no
- * value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed
- * once the API has been created.
Sets the value of the GraphQL API to public (GLOBAL) or private
+ * (PRIVATE). If no value is provided, the visibility will be set to
+ * GLOBAL by default. This value cannot be changed once the API has been
+ * created.
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API
- * (MERGED).
The value that indicates whether the GraphQL API is a standard API
+ * (GRAPHQL) or merged API (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role
- * on behalf of the Merged API to validate access to source APIs at runtime and to prompt the
- * AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The Identity and Access Management service role ARN for a merged API. The AppSync
+ * service assumes this role on behalf of the Merged API to validate access to source APIs at
+ * runtime and to prompt the AUTO_MERGE to update the merged API endpoint with
+ * the source API changes automatically.
Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)
- * introspection. If no value is provided, the introspection configuration will be set to ENABLED by
- * default. This field will produce an error if the operation attempts to use the introspection feature while this
- * field is disabled.
For more information about introspection, see GraphQL - * introspection.
+ *Sets the value of the GraphQL API to enable (ENABLED) or disable
+ * (DISABLED) introspection. If no value is provided, the introspection
+ * configuration will be set to ENABLED by default. This field will produce an
+ * error if the operation attempts to use the introspection feature while this field is
+ * disabled.
For more information about introspection, see GraphQL introspection.
* @public */ introspectionConfig?: GraphQLApiIntrospectionConfig; /** - *The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed
- * in the body of query. The default value is 0 (or unspecified), which indicates there's no depth
- * limit. If you set a limit, it can be between 1 and 75 nested levels. This field will
- * produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, - * the error will be thrown upwards to the first nullable field available.
+ *The maximum depth a query can have in a single request. Depth refers to the amount of
+ * nested levels allowed in the body of query. The default value is 0 (or
+ * unspecified), which indicates there's no depth limit. If you set a limit, it can be between
+ * 1 and 75 nested levels. This field will produce a limit error
+ * if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field + * produces an error, the error will be thrown upwards to the first nullable field + * available.
* @public */ queryDepthLimit?: number; /** - *The maximum number of resolvers that can be invoked in a single request. The default value is 0
- * (or unspecified), which will set the limit to 10000. When specified, the limit value can be
- * between 1 and 10000. This field will produce a limit error if the operation falls out
- * of bounds.
The maximum number of resolvers that can be invoked in a single request. The default
+ * value is 0 (or unspecified), which will set the limit to 10000.
+ * When specified, the limit value can be between 1 and 10000. This
+ * field will produce a limit error if the operation falls out of bounds.
The caching keys for a resolver that has caching activated.
- *Valid values are entries from the $context.arguments, $context.source, and
- * $context.identity maps.
Valid values are entries from the $context.arguments,
+ * $context.source, and $context.identity maps.
The mapping template to use for requests.
- *A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source - * can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
- *VTL request mapping templates are optional when using an Lambda data source. For all other - * data sources, VTL request and response mapping templates are required.
+ *A resolver uses a request mapping template to convert a GraphQL expression into a format + * that a data source can understand. Mapping templates are written in Apache Velocity + * Template Language (VTL).
+ *VTL request mapping templates are optional when using an Lambda data + * source. For all other data sources, VTL request and response mapping templates are + * required.
* @public */ requestMappingTemplate?: string; @@ -3047,14 +3512,16 @@ export interface CreateResolverRequest { *- * UNIT: A UNIT resolver type. A UNIT resolver is the default - * resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
+ * UNIT: A UNIT resolver type. A UNIT resolver is + * the default resolver type. You can use a UNIT resolver to run a GraphQL query against + * a single data source. *
- * PIPELINE: A PIPELINE resolver type. You can use a PIPELINE
- * resolver to invoke a series of Function objects in a serial manner. You can use a pipeline
- * resolver to run a GraphQL query against multiple data sources.
Function objects in a
+ * serial manner. You can use a pipeline resolver to run a GraphQL query against
+ * multiple data sources.
* 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 that if a runtime is specified, code must - * also be specified.
+ *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 + * that if a runtime is specified, code must also be specified.
* @public */ runtime?: AppSyncRuntime; /** - *The resolver code that contains the request and response functions. When code is used, the
- * runtime is required. The runtime value must be APPSYNC_JS.
The resolver code that contains the request and response functions. When
+ * code is used, the runtime is required. The runtime value must be
+ * APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig
- * won't be used unless the resolverLevelMetricsBehavior value is set to
- * PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to
- * FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you
- * can still set its value.
Enables or disables enhanced resolver metrics for specified resolvers. Note that
+ * metricsConfig won't be used unless the
+ * resolverLevelMetricsBehavior value is set to
+ * PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is
+ * set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will
+ * be ignored. However, you can still set its value.
* metricsConfig can be ENABLED or DISABLED.
- * UNIT: A UNIT resolver type. A UNIT resolver is the default - * resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
+ * UNIT: A UNIT resolver type. A UNIT resolver is + * the default resolver type. You can use a UNIT resolver to run a GraphQL query against + * a single data source. *
- * PIPELINE: A PIPELINE resolver type. You can use a PIPELINE
- * resolver to invoke a series of Function objects in a serial manner. You can use a pipeline
- * resolver to run a GraphQL query against multiple data sources.
Function objects in a
+ * serial manner. You can use a pipeline resolver to run a GraphQL query against
+ * multiple data sources.
* 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 that if a runtime is specified, code must - * also be specified.
+ *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 + * that if a runtime is specified, code must also be specified.
* @public */ runtime?: AppSyncRuntime; /** - *The resolver code that contains the request and response functions. When code is used, the
- * runtime is required. The runtime value must be APPSYNC_JS.
The resolver code that contains the request and response functions. When
+ * code is used, the runtime is required. The runtime value must be
+ * APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig
- * won't be used unless the resolverLevelMetricsBehavior value is set to
- * PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to
- * FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you
- * can still set its value.
Enables or disables enhanced resolver metrics for specified resolvers. Note that
+ * metricsConfig won't be used unless the
+ * resolverLevelMetricsBehavior value is set to
+ * PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is
+ * set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will
+ * be ignored. However, you can still set its value.
* metricsConfig can be ENABLED or DISABLED.
The Api ID.
Represents the input of a DeleteApiCache operation.
The ID of the Api associated with the ChannelNamespace.
The name of the ChannelNamespace.
The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source - * APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs - * from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
+ *The identifier of the AppSync Source API. This is generated by the AppSync service. In + * most cases, source APIs (especially in your account) only require the API ID value or ARN + * of the source API. However, source APIs from other accounts (cross-account use cases) + * strictly require the full resource ARN of the source API.
* @public */ sourceApiIdentifier: string | undefined; @@ -3539,9 +4049,10 @@ export interface DisassociateMergedGraphqlApiResponse { */ export interface DisassociateSourceGraphqlApiRequest { /** - *The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged - * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs - * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
+ *The identifier of the AppSync Merged API. This is generated by the AppSync service. In + * most cases, Merged APIs (especially in your account) only require the API ID value or ARN + * of the merged API. However, Merged APIs in other accounts (cross-account use cases) + * strictly require the full resource ARN of the merged API.
* @public */ mergedApiIdentifier: string | undefined; @@ -3569,29 +4080,30 @@ export interface DisassociateSourceGraphqlApiResponse { */ export interface EvaluateCodeRequest { /** - *The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is
- * supported.
The runtime to be used when evaluating the code. Currently, only the
+ * APPSYNC_JS runtime is supported.
The code definition to be evaluated. Note that code and runtime are both required
- * for this action. The runtime value must be APPSYNC_JS.
The code definition to be evaluated. Note that code and
+ * runtime are both required for this action. The runtime value
+ * must be APPSYNC_JS.
The map that holds all of the contextual information for your resolver invocation. A context is
- * required for this action.
The map that holds all of the contextual information for your resolver invocation. A
+ * context is required for this action.
The function within the code to be evaluated. If provided, the valid values are request and
- * response.
The function within the code to be evaluated. If provided, the valid values are
+ * request and response.
A list of logs that were generated by calls to util.log.info and util.log.error in
- * the evaluated code.
A list of logs that were generated by calls to util.log.info and
+ * util.log.error in the evaluated code.
The mapping template; this can be a request or response template. A template is required for
- * this action.
The mapping template; this can be a request or response template. A
+ * template is required for this action.
The map that holds all of the contextual information for your resolver invocation. A context is
- * required for this action.
The map that holds all of the contextual information for your resolver invocation. A
+ * context is required for this action.
Contains the list of errors generated. When using JavaScript, this will apply to the request or response - * function evaluation.
+ *Contains the list of errors generated. When using JavaScript, this will apply to the + * request or response function evaluation.
* @public */ export interface ErrorDetail { @@ -3688,8 +4200,8 @@ export interface EvaluateMappingTemplateResponse { error?: ErrorDetail; /** - *A list of logs that were generated by calls to util.log.info and util.log.error in
- * the evaluated code.
A list of logs that were generated by calls to util.log.info and
+ * util.log.error in the evaluated code.
The Api ID.
The Api object.
The Api ID.
The name of the ChannelNamespace.
The ChannelNamespace object.
The introspection ID. Each introspection contains a unique ID that can be used to reference the - * instrospection record.
+ *The introspection ID. Each introspection contains a unique ID that can be used to + * reference the instrospection record.
* @public */ introspectionId: string | undefined; /** - *A boolean flag that determines whether SDL should be generated for introspected types or not. If set to
- * true, each model will contain an sdl property that contains the SDL for that type.
- * The SDL only contains the type data and no additional metadata or directives.
A boolean flag that determines whether SDL should be generated for introspected types.
+ * If set to true, each model will contain an sdl property that
+ * contains the SDL for that type. The SDL only contains the type data and no additional
+ * metadata or directives.
Determines the number of types to be returned in a single response before paginating. This value is
- * typically taken from nextToken value from the previous response.
Determines the number of types to be returned in a single response before paginating.
+ * This value is typically taken from nextToken value from the previous
+ * response.
The maximum number of introspected types that will be returned in a single response.
+ *The maximum number of introspected types that will be returned in a single + * response.
* @public */ maxResults?: number; @@ -3942,7 +4507,8 @@ export interface GetGraphqlApiEnvironmentVariablesRequest { */ export interface GetGraphqlApiEnvironmentVariablesResponse { /** - *The payload containing each environmental variable in the "key" : "value" format.
The payload containing each environmental variable in the "key" : "value"
+ * format.
The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the - * ACTIVE state, you can add data.
+ *The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When + * the schema is in the ACTIVE state, you can add data.
* @public */ status?: SchemaStatus; @@ -4104,9 +4670,10 @@ export interface GetSchemaCreationStatusResponse { */ export interface GetSourceApiAssociationRequest { /** - *The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged - * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs - * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
+ *The identifier of the AppSync Merged API. This is generated by the AppSync service. In + * most cases, Merged APIs (especially in your account) only require the API ID value or ARN + * of the merged API. However, Merged APIs in other accounts (cross-account use cases) + * strictly require the full resource ARN of the merged API.
* @public */ mergedApiIdentifier: string | undefined; @@ -4174,8 +4741,8 @@ export interface ListApiKeysRequest { apiId: string | undefined; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4198,8 +4765,86 @@ export interface ListApiKeysResponse { apiKeys?: ApiKey[]; /** - *An identifier to pass in the next request to this operation to return the next set of items in the - * list.
+ *An identifier to pass in the next request to this operation to return the next set of + * items in the list.
+ * @public + */ + nextToken?: string; +} + +/** + * @public + */ +export interface ListApisRequest { + /** + *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
+ * @public + */ + nextToken?: string; + + /** + *The maximum number of results that you want the request to return.
+ * @public + */ + maxResults?: number; +} + +/** + * @public + */ +export interface ListApisResponse { + /** + *The Api objects.
An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
+ * @public + */ + nextToken?: string; +} + +/** + * @public + */ +export interface ListChannelNamespacesRequest { + /** + *The Api ID.
An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
+ * @public + */ + nextToken?: string; + + /** + *The maximum number of results that you want the request to return.
+ * @public + */ + maxResults?: number; +} + +/** + * @public + */ +export interface ListChannelNamespacesResponse { + /** + *The ChannelNamespace objects.
An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4216,8 +4861,8 @@ export interface ListDataSourcesRequest { apiId: string | undefined; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4240,8 +4885,8 @@ export interface ListDataSourcesResponse { dataSources?: DataSource[]; /** - *An identifier to pass in the next request to this operation to return the next set of items in the - * list.
+ *An identifier to pass in the next request to this operation to return the next set of + * items in the list.
* @public */ nextToken?: string; @@ -4252,8 +4897,8 @@ export interface ListDataSourcesResponse { */ export interface ListDomainNamesRequest { /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4276,8 +4921,8 @@ export interface ListDomainNamesResponse { domainNameConfigs?: DomainNameConfig[]; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4294,8 +4939,8 @@ export interface ListFunctionsRequest { apiId: string | undefined; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4318,8 +4963,8 @@ export interface ListFunctionsResponse { functions?: FunctionConfiguration[]; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4344,8 +4989,8 @@ export type Ownership = (typeof Ownership)[keyof typeof Ownership]; */ export interface ListGraphqlApisRequest { /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4357,8 +5002,8 @@ export interface ListGraphqlApisRequest { maxResults?: number; /** - *The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API
- * (MERGED).
The value that indicates whether the GraphQL API is a standard API
+ * (GRAPHQL) or merged API (MERGED).
An identifier to pass in the next request to this operation to return the next set of items in the - * list.
+ *An identifier to pass in the next request to this operation to return the next set of + * items in the list.
* @public */ nextToken?: string; @@ -4405,8 +5050,8 @@ export interface ListResolversRequest { typeName: string | undefined; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4429,8 +5074,8 @@ export interface ListResolversResponse { resolvers?: Resolver[]; /** - *An identifier to pass in the next request to this operation to return the next set of items in the - * list.
+ *An identifier to pass in the next request to this operation to return the next set of + * items in the list.
* @public */ nextToken?: string; @@ -4453,8 +5098,8 @@ export interface ListResolversByFunctionRequest { functionId: string | undefined; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4494,8 +5139,8 @@ export interface ListSourceApiAssociationsRequest { apiId: string | undefined; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4566,8 +5211,8 @@ export interface ListSourceApiAssociationsResponse { sourceApiAssociationSummaries?: SourceApiAssociationSummary[]; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4612,8 +5257,8 @@ export interface ListTypesRequest { format: TypeDefinitionFormat | undefined; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4636,8 +5281,8 @@ export interface ListTypesResponse { types?: Type[]; /** - *An identifier to pass in the next request to this operation to return the next set of items in the - * list.
+ *An identifier to pass in the next request to this operation to return the next set of + * items in the list.
* @public */ nextToken?: string; @@ -4648,9 +5293,10 @@ export interface ListTypesResponse { */ export interface ListTypesByAssociationRequest { /** - *The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged - * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs - * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
+ *The identifier of the AppSync Merged API. This is generated by the AppSync service. In + * most cases, Merged APIs (especially in your account) only require the API ID value or ARN + * of the merged API. However, Merged APIs in other accounts (cross-account use cases) + * strictly require the full resource ARN of the merged API.
* @public */ mergedApiIdentifier: string | undefined; @@ -4668,8 +5314,8 @@ export interface ListTypesByAssociationRequest { format: TypeDefinitionFormat | undefined; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4692,8 +5338,8 @@ export interface ListTypesByAssociationResponse { types?: Type[]; /** - *An identifier that was returned from the previous call to this operation, which you can use to return the - * next set of items in the list.
+ *An identifier that was returned from the previous call to this operation, which you can + * use to return the next set of items in the list.
* @public */ nextToken?: string; @@ -4711,8 +5357,8 @@ export interface PutGraphqlApiEnvironmentVariablesRequest { /** *The list of environmental variables to add to the API.
- *When creating an environmental variable key-value pair, it must follow the additional constraints - * below:
+ *When creating an environmental variable key-value pair, it must follow the additional + * constraints below:
*Keys must begin with a letter.
@@ -4721,7 +5367,8 @@ export interface PutGraphqlApiEnvironmentVariablesRequest { *Keys must be at least two characters long.
*Keys can only contain letters, numbers, and the underscore character (_).
+ *Keys can only contain letters, numbers, and the underscore character + * (_).
*Values can be up to 512 characters long.
@@ -4730,12 +5377,13 @@ export interface PutGraphqlApiEnvironmentVariablesRequest { *You can configure up to 50 key-value pairs in a GraphQL API.
*You can create a list of environmental variables by adding it to the environmentVariables
- * payload as a list in the format \{"key1":"value1","key2":"value2", …\}. Note that each call of the
- * PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing
- * environmental variable list of that API. This means the existing environmental variables will be lost. To avoid
- * this, you must include all existing and new environmental variables in the list each time you call this
- * action.
You can create a list of environmental variables by adding it to the
+ * environmentVariables payload as a list in the format
+ * \{"key1":"value1","key2":"value2", …\}. Note that each call of the
+ * PutGraphqlApiEnvironmentVariables action will result in the overwriting of
+ * the existing environmental variable list of that API. This means the existing environmental
+ * variables will be lost. To avoid this, you must include all existing and new environmental
+ * variables in the list each time you call this action.
The payload containing each environmental variable in the "key" : "value" format.
The payload containing each environmental variable in the "key" : "value"
+ * format.
The secret's ARN that was obtained from Secrets Manager. A secret consists of secret information, the secret - * value, plus metadata about the secret. A secret value can be a string or binary. It typically includes the ARN, - * secret name and description, policies, tags, encryption key from the Key Management Service, and key rotation - * data.
+ *The secret's ARN that was obtained from Secrets Manager. A secret consists of secret + * information, the secret value, plus metadata about the secret. A secret value can be a + * string or binary. It typically includes the ARN, secret name and description, policies, + * tags, encryption key from the Key Management Service, and key rotation data.
* @public */ secretArn: string | undefined; @@ -4795,25 +5444,26 @@ export interface StartDataSourceIntrospectionRequest { */ export interface StartDataSourceIntrospectionResponse { /** - *The introspection ID. Each introspection contains a unique ID that can be used to reference the - * instrospection record.
+ *The introspection ID. Each introspection contains a unique ID that can be used to + * reference the instrospection record.
* @public */ introspectionId?: string; /** - *The status of the introspection during creation. By default, when a new instrospection has been created, the
- * status will be set to PROCESSING. Once the operation has been completed, the status will change to
- * SUCCESS or FAILED depending on how the data was parsed. A FAILED
- * operation will return an error and its details as an introspectionStatusDetail.
The status of the introspection during creation. By default, when a new instrospection
+ * has been created, the status will be set to PROCESSING. Once the operation has
+ * been completed, the status will change to SUCCESS or FAILED
+ * depending on how the data was parsed. A FAILED operation will return an error
+ * and its details as an introspectionStatusDetail.
The error detail field. When a FAILED
- * introspectionStatus is returned, the introspectionStatusDetail will also return the
- * exact error that was generated during the operation.
introspectionStatus is returned, the introspectionStatusDetail
+ * will also return the exact error that was generated during the operation.
* @public
*/
introspectionStatusDetail?: string;
@@ -4841,8 +5491,8 @@ export interface StartSchemaCreationRequest {
*/
export interface StartSchemaCreationResponse {
/**
- * The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the - * ACTIVE state, you can add data.
+ *The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When + * the schema is in the ACTIVE state, you can add data.
* @public */ status?: SchemaStatus; @@ -4859,9 +5509,10 @@ export interface StartSchemaMergeRequest { associationId: string | undefined; /** - *The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged - * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs - * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
+ *The identifier of the AppSync Merged API. This is generated by the AppSync service. In + * most cases, Merged APIs (especially in your account) only require the API ID value or ARN + * of the merged API. However, Merged APIs in other accounts (cross-account use cases) + * strictly require the full resource ARN of the merged API.
* @public */ mergedApiIdentifier: string | undefined; @@ -4922,6 +5573,47 @@ export interface UntagResourceRequest { */ export interface UntagResourceResponse {} +/** + * @public + */ +export interface UpdateApiRequest { + /** + *The Api ID.
The name of the Api.
+ * @public + */ + name: string | undefined; + + /** + *The owner contact information for the Api.
The new event configuration. This includes the default authorization configuration for + * connecting, publishing, and subscribing to an Event API.
+ * @public + */ + eventConfig?: EventConfig; +} + +/** + * @public + */ +export interface UpdateApiResponse { + /** + *The Api object.
Represents the input of a UpdateApiCache operation.
- * FULL_REQUEST_CACHING: All requests are fully cached.
+ * FULL_REQUEST_CACHING: All requests are fully + * cached. *- * PER_RESOLVER_CACHING: Individual resolvers that you specify are - * cached.
+ * PER_RESOLVER_CACHING: Individual resolvers + * that you specify are cached. *Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
+ *Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics + * include:
*NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded - * the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache - * configuration.
+ *NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the + * throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing + * bottlenecks in a cache configuration.
*EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is - * useful for diagnosing bottlenecks in a cache configuration.
+ *EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis + * process. This is useful for diagnosing bottlenecks in a cache + * configuration.
*Metrics will be recorded by API ID. You can set the value to ENABLED or
- * DISABLED.
DISABLED.
* @public
*/
healthMetricsConfig?: CacheHealthMetricsConfig;
@@ -5091,8 +5786,8 @@ export interface UpdateApiKeyRequest {
description?: string;
/**
- * From the update time, the time after which the API key expires. The date is represented as seconds since the - * epoch. For more information, see .
+ *From the update time, the time after which the API key expires. The date is represented + * as seconds since the epoch. For more information, see .
* @public */ expires?: number; @@ -5109,6 +5804,55 @@ export interface UpdateApiKeyResponse { apiKey?: ApiKey; } +/** + * @public + */ +export interface UpdateChannelNamespaceRequest { + /** + *The Api ID.
The name of the ChannelNamespace.
The authorization mode to use for subscribing to messages on the channel namespace. This
+ * configuration overrides the default Api authorization configuration.
The authorization mode to use for publishing messages on the channel namespace. This
+ * configuration overrides the default Api authorization configuration.
The event handler functions that run custom business logic to process published events + * and subscribe requests.
+ * @public + */ + codeHandlers?: string; +} + +/** + * @public + */ +export interface UpdateChannelNamespaceResponse { + /** + *The ChannelNamespace object.
The new OpenSearch configuration.
- *As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is - * deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.
+ *As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This + * configuration is deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.
* @public */ elasticsearchConfig?: ElasticsearchDataSourceConfig; @@ -5189,10 +5933,11 @@ export interface UpdateDataSourceRequest { /** *Enables or disables enhanced data source metrics for specified data sources. Note that
- * metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set
- * to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to
- * FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,
- * you can still set its value.
metricsConfig won't be used unless the
+ * dataSourceLevelMetricsBehavior value is set to
+ * PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior
+ * is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig
+ * will be ignored. However, you can still set its value.
*
* metricsConfig can be ENABLED or DISABLED.
The Function request mapping template. Functions support only the 2018-05-29 version of the
- * request mapping template.
The Function request mapping template. Functions support only the
+ * 2018-05-29 version of the request mapping template.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note
- * that when using VTL and mapping templates, the functionVersion is required.
The version of the request mapping template. Currently, the supported value
+ * is 2018-05-29. Note that when using VTL and mapping templates, the
+ * functionVersion is required.
Describes a Sync configuration for a resolver.
- *Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is - * invoked.
+ *Specifies which Conflict Detection strategy and Resolution strategy to use when the + * resolver is invoked.
* @public */ syncConfig?: SyncConfig; @@ -5309,16 +6055,16 @@ export interface UpdateFunctionRequest { maxBatchSize?: number; /** - *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 that if a runtime is specified, code must - * also be specified.
+ *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 + * that if a runtime is specified, code must also be specified.
* @public */ runtime?: AppSyncRuntime; /** - *The function code that contains the request and response functions. When code is used, the
- * runtime is required. The runtime value must be APPSYNC_JS.
The function code that contains the request and response functions. When
+ * code is used, the runtime is required. The runtime value must be
+ * APPSYNC_JS.
The new authentication type for the GraphqlApi object.
The new Amazon Cognito user pool configuration for the ~GraphqlApi object.
The new Amazon Cognito user pool configuration for the ~GraphqlApi
+ * object.
A list of additional authentication providers for the GraphqlApi API.
A list of additional authentication providers for the GraphqlApi
+ * API.
A flag indicating whether to use X-Ray tracing for the GraphqlApi.
A flag indicating whether to use X-Ray tracing for the
+ * GraphqlApi.
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role
- * on behalf of the Merged API to validate access to source APIs at runtime and to prompt the
- * AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The Identity and Access Management service role ARN for a merged API. The AppSync
+ * service assumes this role on behalf of the Merged API to validate access to source APIs at
+ * runtime and to prompt the AUTO_MERGE to update the merged API endpoint with
+ * the source API changes automatically.
Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)
- * introspection. If no value is provided, the introspection configuration will be set to ENABLED by
- * default. This field will produce an error if the operation attempts to use the introspection feature while this
- * field is disabled.
For more information about introspection, see GraphQL - * introspection.
+ *Sets the value of the GraphQL API to enable (ENABLED) or disable
+ * (DISABLED) introspection. If no value is provided, the introspection
+ * configuration will be set to ENABLED by default. This field will produce an
+ * error if the operation attempts to use the introspection feature while this field is
+ * disabled.
For more information about introspection, see GraphQL introspection.
* @public */ introspectionConfig?: GraphQLApiIntrospectionConfig; /** - *The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed
- * in the body of query. The default value is 0 (or unspecified), which indicates there's no depth
- * limit. If you set a limit, it can be between 1 and 75 nested levels. This field will
- * produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, - * the error will be thrown upwards to the first nullable field available.
+ *The maximum depth a query can have in a single request. Depth refers to the amount of
+ * nested levels allowed in the body of query. The default value is 0 (or
+ * unspecified), which indicates there's no depth limit. If you set a limit, it can be between
+ * 1 and 75 nested levels. This field will produce a limit error
+ * if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field + * produces an error, the error will be thrown upwards to the first nullable field + * available.
* @public */ queryDepthLimit?: number; /** - *The maximum number of resolvers that can be invoked in a single request. The default value is 0
- * (or unspecified), which will set the limit to 10000. When specified, the limit value can be
- * between 1 and 10000. This field will produce a limit error if the operation falls out
- * of bounds.
The maximum number of resolvers that can be invoked in a single request. The default
+ * value is 0 (or unspecified), which will set the limit to 10000.
+ * When specified, the limit value can be between 1 and 10000. This
+ * field will produce a limit error if the operation falls out of bounds.
The new request mapping template.
- *A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source - * can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
- *VTL request mapping templates are optional when using an Lambda data source. For all other - * data sources, VTL request and response mapping templates are required.
+ *A resolver uses a request mapping template to convert a GraphQL expression into a format + * that a data source can understand. Mapping templates are written in Apache Velocity + * Template Language (VTL).
+ *VTL request mapping templates are optional when using an Lambda data + * source. For all other data sources, VTL request and response mapping templates are + * required.
* @public */ requestMappingTemplate?: string; @@ -5506,14 +6260,16 @@ export interface UpdateResolverRequest { *- * UNIT: A UNIT resolver type. A UNIT resolver is the default - * resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
+ * UNIT: A UNIT resolver type. A UNIT resolver is + * the default resolver type. You can use a UNIT resolver to run a GraphQL query against + * a single data source. *
- * PIPELINE: A PIPELINE resolver type. You can use a PIPELINE
- * resolver to invoke a series of Function objects in a serial manner. You can use a pipeline
- * resolver to run a GraphQL query against multiple data sources.
Function objects in a
+ * serial manner. You can use a pipeline resolver to run a GraphQL query against
+ * multiple data sources.
* 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 that if a runtime is specified, code must - * also be specified.
+ *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 + * that if a runtime is specified, code must also be specified.
* @public */ runtime?: AppSyncRuntime; /** - *The resolver code that contains the request and response functions. When code is used, the
- * runtime is required. The runtime value must be APPSYNC_JS.
The resolver code that contains the request and response functions. When
+ * code is used, the runtime is required. The runtime value must be
+ * APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig
- * won't be used unless the resolverLevelMetricsBehavior value is set to
- * PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to
- * FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you
- * can still set its value.
Enables or disables enhanced resolver metrics for specified resolvers. Note that
+ * metricsConfig won't be used unless the
+ * resolverLevelMetricsBehavior value is set to
+ * PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is
+ * set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will
+ * be ignored. However, you can still set its value.
* metricsConfig can be ENABLED or DISABLED.
The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged - * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs - * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
+ *The identifier of the AppSync Merged API. This is generated by the AppSync service. In + * most cases, Merged APIs (especially in your account) only require the API ID value or ARN + * of the merged API. However, Merged APIs in other accounts (cross-account use cases) + * strictly require the full resource ARN of the merged API.
* @public */ mergedApiIdentifier: string | undefined; @@ -5671,17 +6429,20 @@ export interface UpdateTypeResponse { */ export interface DataSourceIntrospectionModelFieldType { /** - *Specifies the classification of data. For example, this could be set to values like Scalar or
- * NonNull to indicate a fundamental property of the field.
Specifies the classification of data. For example, this could be set to values like
+ * Scalar or NonNull to indicate a fundamental property of the
+ * field.
Valid values include:
*
- * Scalar: Indicates the value is a primitive type (scalar).
Scalar: Indicates the value is a primitive type
+ * (scalar).
*
- * NonNull: Indicates the field cannot be null.
NonNull: Indicates the field cannot be
+ * null.
* @@ -5693,26 +6454,29 @@ export interface DataSourceIntrospectionModelFieldType { kind?: string; /** - *
The name of the data type that represents the field. For example, String is a valid
- * name value.
The name of the data type that represents the field. For example, String is
+ * a valid name value.
The DataSourceIntrospectionModelFieldType object data. The type is only present if
- * DataSourceIntrospectionModelFieldType.kind is set to NonNull or List.
The type typically contains its own kind and name fields to represent
- * the actual type data. For instance, type could contain a kind value of
- * Scalar with a name value of String. The values Scalar
- * and String will be collectively stored in the values field.
The DataSourceIntrospectionModelFieldType object data. The
+ * type is only present if
+ * DataSourceIntrospectionModelFieldType.kind is set to NonNull
+ * or List.
The type typically contains its own kind and name
+ * fields to represent the actual type data. For instance, type could contain a
+ * kind value of Scalar with a name value of
+ * String. The values Scalar and String will be
+ * collectively stored in the values field.
The values of the type field. This field represents the AppSync data type equivalent of the
- * introspected field.
The values of the type field. This field represents the AppSync data type
+ * equivalent of the introspected field.
The name of the model. For example, this could be the name of a single table in a database.
+ *The name of the model. For example, this could be the name of a single table in a + * database.
* @public */ name?: string; @@ -5760,7 +6525,8 @@ export interface DataSourceIntrospectionModel { fields?: DataSourceIntrospectionModelField[]; /** - *The primary key stored as a DataSourceIntrospectionModelIndex object.
The primary key stored as a DataSourceIntrospectionModelIndex
+ * object.
Contains the output of the SDL that was generated from the introspected types. This is controlled by the
- * includeModelsSDL parameter of the GetDataSourceIntrospection operation.
Contains the output of the SDL that was generated from the introspected types. This is
+ * controlled by the includeModelsSDL parameter of the
+ * GetDataSourceIntrospection operation.
Represents the output of a DataSourceIntrospectionResult. This is the populated result of a
- * GetDataSourceIntrospection operation.
Represents the output of a DataSourceIntrospectionResult. This is the
+ * populated result of a GetDataSourceIntrospection operation.
Determines the number of types to be returned in a single response before paginating. This value is
- * typically taken from nextToken value from the previous response.
Determines the number of types to be returned in a single response before paginating.
+ * This value is typically taken from nextToken value from the previous
+ * response.
The introspection ID. Each introspection contains a unique ID that can be used to reference the - * instrospection record.
+ *The introspection ID. Each introspection contains a unique ID that can be used to + * reference the instrospection record.
* @public */ introspectionId?: string; /** - *The status of the introspection during retrieval. By default, when a new instrospection is being retrieved,
- * the status will be set to PROCESSING. Once the operation has been completed, the status will
- * change to SUCCESS or FAILED depending on how the data was parsed. A
- * FAILED operation will return an error and its details as an
- * introspectionStatusDetail.
The status of the introspection during retrieval. By default, when a new instrospection
+ * is being retrieved, the status will be set to PROCESSING. Once the operation
+ * has been completed, the status will change to SUCCESS or FAILED
+ * depending on how the data was parsed. A FAILED operation will return an error
+ * and its details as an introspectionStatusDetail.
The error detail field. When a FAILED
- * introspectionStatus is returned, the introspectionStatusDetail will also return the
- * exact error that was generated during the operation.
introspectionStatus is returned, the introspectionStatusDetail
+ * will also return the exact error that was generated during the operation.
* @public
*/
introspectionStatusDetail?: string;
diff --git a/clients/client-appsync/src/pagination/ListApisPaginator.ts b/clients/client-appsync/src/pagination/ListApisPaginator.ts
new file mode 100644
index 000000000000..9d8609dab04a
--- /dev/null
+++ b/clients/client-appsync/src/pagination/ListApisPaginator.ts
@@ -0,0 +1,20 @@
+// smithy-typescript generated code
+import { createPaginator } from "@smithy/core";
+import { Paginator } from "@smithy/types";
+
+import { AppSyncClient } from "../AppSyncClient";
+import { ListApisCommand, ListApisCommandInput, ListApisCommandOutput } from "../commands/ListApisCommand";
+import { AppSyncPaginationConfiguration } from "./Interfaces";
+
+/**
+ * @public
+ */
+export const paginateListApis: (
+ config: AppSyncPaginationConfiguration,
+ input: ListApisCommandInput,
+ ...rest: any[]
+) => PaginatorAppSync provides API actions for creating and interacting with data\n sources using GraphQL from your application.
", + "smithy.api#title": "AWS AppSync", + "smithy.api#xmlNamespace": { + "uri": "http://appsync.amazonaws.com" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.appsync#AWSDeepdishControlPlaneService": { - "type": "service", - "version": "2017-07-25", - "operations": [ - { - "target": "com.amazonaws.appsync#AssociateApi" - }, - { - "target": "com.amazonaws.appsync#AssociateMergedGraphqlApi" - }, - { - "target": "com.amazonaws.appsync#AssociateSourceGraphqlApi" - }, - { - "target": "com.amazonaws.appsync#CreateApiCache" - }, - { - "target": "com.amazonaws.appsync#CreateApiKey" - }, - { - "target": "com.amazonaws.appsync#CreateDataSource" - }, - { - "target": "com.amazonaws.appsync#CreateDomainName" - }, - { - "target": "com.amazonaws.appsync#CreateFunction" - }, - { - "target": "com.amazonaws.appsync#CreateGraphqlApi" - }, - { - "target": "com.amazonaws.appsync#CreateResolver" - }, - { - "target": "com.amazonaws.appsync#CreateType" - }, - { - "target": "com.amazonaws.appsync#DeleteApiCache" - }, - { - "target": "com.amazonaws.appsync#DeleteApiKey" - }, - { - "target": "com.amazonaws.appsync#DeleteDataSource" - }, - { - "target": "com.amazonaws.appsync#DeleteDomainName" - }, - { - "target": "com.amazonaws.appsync#DeleteFunction" - }, - { - "target": "com.amazonaws.appsync#DeleteGraphqlApi" - }, - { - "target": "com.amazonaws.appsync#DeleteResolver" - }, - { - "target": "com.amazonaws.appsync#DeleteType" - }, - { - "target": "com.amazonaws.appsync#DisassociateApi" - }, - { - "target": "com.amazonaws.appsync#DisassociateMergedGraphqlApi" - }, + "conditions": [ { - "target": "com.amazonaws.appsync#DisassociateSourceGraphqlApi" - }, - { - "target": "com.amazonaws.appsync#EvaluateCode" - }, - { - "target": "com.amazonaws.appsync#EvaluateMappingTemplate" - }, - { - "target": "com.amazonaws.appsync#FlushApiCache" - }, - { - "target": "com.amazonaws.appsync#GetApiAssociation" - }, - { - "target": "com.amazonaws.appsync#GetApiCache" - }, - { - "target": "com.amazonaws.appsync#GetDataSource" - }, - { - "target": "com.amazonaws.appsync#GetDataSourceIntrospection" - }, - { - "target": "com.amazonaws.appsync#GetDomainName" - }, - { - "target": "com.amazonaws.appsync#GetFunction" - }, - { - "target": "com.amazonaws.appsync#GetGraphqlApi" - }, - { - "target": "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariables" - }, - { - "target": "com.amazonaws.appsync#GetIntrospectionSchema" - }, - { - "target": "com.amazonaws.appsync#GetResolver" - }, - { - "target": "com.amazonaws.appsync#GetSchemaCreationStatus" - }, - { - "target": "com.amazonaws.appsync#GetSourceApiAssociation" - }, - { - "target": "com.amazonaws.appsync#GetType" - }, - { - "target": "com.amazonaws.appsync#ListApiKeys" - }, - { - "target": "com.amazonaws.appsync#ListDataSources" - }, - { - "target": "com.amazonaws.appsync#ListDomainNames" - }, - { - "target": "com.amazonaws.appsync#ListFunctions" - }, - { - "target": "com.amazonaws.appsync#ListGraphqlApis" - }, - { - "target": "com.amazonaws.appsync#ListResolvers" - }, - { - "target": "com.amazonaws.appsync#ListResolversByFunction" - }, - { - "target": "com.amazonaws.appsync#ListSourceApiAssociations" - }, - { - "target": "com.amazonaws.appsync#ListTagsForResource" - }, - { - "target": "com.amazonaws.appsync#ListTypes" - }, - { - "target": "com.amazonaws.appsync#ListTypesByAssociation" - }, - { - "target": "com.amazonaws.appsync#PutGraphqlApiEnvironmentVariables" - }, - { - "target": "com.amazonaws.appsync#StartDataSourceIntrospection" - }, - { - "target": "com.amazonaws.appsync#StartSchemaCreation" - }, - { - "target": "com.amazonaws.appsync#StartSchemaMerge" - }, - { - "target": "com.amazonaws.appsync#TagResource" - }, - { - "target": "com.amazonaws.appsync#UntagResource" - }, - { - "target": "com.amazonaws.appsync#UpdateApiCache" - }, - { - "target": "com.amazonaws.appsync#UpdateApiKey" - }, - { - "target": "com.amazonaws.appsync#UpdateDataSource" - }, - { - "target": "com.amazonaws.appsync#UpdateDomainName" - }, - { - "target": "com.amazonaws.appsync#UpdateFunction" - }, + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ { - "target": "com.amazonaws.appsync#UpdateGraphqlApi" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, { - "target": "com.amazonaws.appsync#UpdateResolver" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" }, { - "target": "com.amazonaws.appsync#UpdateSourceApiAssociation" - }, + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ { - "target": "com.amazonaws.appsync#UpdateType" + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] } - ], - "traits": { - "aws.api#service": { - "sdkId": "AppSync", - "arnNamespace": "appsync", - "cloudFormationName": "AppSync", - "cloudTrailEventSource": "appsync.amazonaws.com", - "endpointPrefix": "appsync" - }, - "aws.auth#sigv4": { - "name": "appsync" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AppSync provides API actions for creating and interacting with data sources using GraphQL\n from your application.
", - "smithy.api#title": "AWS AppSync", - "smithy.api#xmlNamespace": { - "uri": "http://appsync.amazonaws.com" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" } - }, - "rules": [ + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] }, { - "conditions": [ + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] } - ], - "rules": [ + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appsync-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appsync-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appsync.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://appsync.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] } - ], - "type": "tree" + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appsync-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" }, { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ + ], + "type": "tree" + }, + { + "conditions": [ { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-east-1.amazonaws.com" - } + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appsync-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } + ], + "type": "tree" }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appsync-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appsync-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appsync.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appsync-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, + true + ] + } + ], + "rules": [ { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" + ] } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appsync.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } + ], + "type": "tree" }, { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } - ], - "version": "1.0" + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://appsync.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } + ] }, - "com.amazonaws.appsync#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-east-1.amazonaws.com" } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "You don't have access to perform this operation on this resource.
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.appsync#AdditionalAuthenticationProvider": { - "type": "structure", - "members": { - "authenticationType": { - "target": "com.amazonaws.appsync#AuthenticationType", - "traits": { - "smithy.api#documentation": "The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),\n Amazon Cognito user pools, or Lambda.
" - } - }, - "openIDConnectConfig": { - "target": "com.amazonaws.appsync#OpenIDConnectConfig", - "traits": { - "smithy.api#documentation": "The OIDC configuration.
" - } - }, - "userPoolConfig": { - "target": "com.amazonaws.appsync#CognitoUserPoolConfig", - "traits": { - "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" - } - }, - "lambdaAuthorizerConfig": { - "target": "com.amazonaws.appsync#LambdaAuthorizerConfig", - "traits": { - "smithy.api#documentation": "Configuration for Lambda function authorization.
" - } + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-northeast-1.amazonaws.com" } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "Describes an additional authentication provider.
" - } - }, - "com.amazonaws.appsync#AdditionalAuthenticationProviders": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#AdditionalAuthenticationProvider" - } - }, - "com.amazonaws.appsync#ApiAssociation": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.appsync#DomainName", - "traits": { - "smithy.api#documentation": "The domain name.
" - } - }, - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
" - } - }, - "associationStatus": { - "target": "com.amazonaws.appsync#AssociationStatus", - "traits": { - "smithy.api#documentation": "Identifies the status of an association.
\n\n PROCESSING: The API association is being created. You cannot\n modify association requests during processing.
\n\n SUCCESS: The API association was successful. You can modify\n associations after success.
\n\n FAILED: The API association has failed. You can modify\n associations after failure.
\nDetails about the last deployment status.
" - } + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-northeast-2.amazonaws.com" } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "Describes an ApiAssociation object.
TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
" - } - }, - "apiCachingBehavior": { - "target": "com.amazonaws.appsync#ApiCachingBehavior", - "traits": { - "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nTransit encryption flag when connecting to cache. You cannot update this setting after creation.
" - } - }, - "atRestEncryptionEnabled": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "At-rest encryption flag for cache. You cannot update this setting after creation.
" - } - }, - "type": { - "target": "com.amazonaws.appsync#ApiCacheType", - "traits": { - "smithy.api#documentation": "The cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nThe cache instance status.
\n\n AVAILABLE: The instance is available for use.
\n\n CREATING: The instance is currently creating.
\n\n DELETING: The instance is currently deleting.
\n\n MODIFYING: The instance is currently modifying.
\n\n FAILED: The instance has failed creation.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
The ApiCache object.
The API key ID.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "A description of the purpose of the API key.
" - } - }, - "expires": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The time after which the API key expires. The date is represented as seconds since the epoch, rounded down\n to the nearest hour.
" - } - }, - "deletes": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded\n down to the nearest hour.
" - } + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-south-1.amazonaws.com" } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "Describes an API key.
\nCustomers invoke AppSync GraphQL API operations with API keys as an identity mechanism.\n There are two key versions:
\n\n da1: We introduced this version at launch in November 2017. These keys\n always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid\n after February 21, 2018, and they should no longer be used.
\n\n ListApiKeys returns the expiration time in milliseconds.
\n CreateApiKey returns the expiration time in milliseconds.
\n UpdateApiKey is not available for this key version.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are\n not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a\n one-time action, we deleted these keys from the table on February 21, 2018.
\n\n da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.
\n\n ListApiKeys returns the expiration time and deletion time in seconds.
\n CreateApiKey returns the expiration time and deletion time in seconds and accepts a\n user-provided expiration time in seconds.
\n UpdateApiKey returns the expiration time and and deletion time in seconds and accepts\n a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration\n time. You can update the key expiration time as long as the key isn't deleted.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to\n authenticate will fail. However, you can reinstate the key before deletion.
\nDeletion is stored in DynamoDB as seconds. The key is deleted after deletion\n time.
\nThe API key exceeded a limit. Try your request again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appsync#ApiKeyValidityOutOfBoundsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-southeast-2.amazonaws.com" } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "The API key expiration must be set to a value between 1 and 365 days from creation (for\n CreateApiKey) or from update (for UpdateApiKey).
The GraphQL API exceeded a limit. Try your request again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appsync#AppSyncRuntime": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#RuntimeName", - "traits": { - "smithy.api#documentation": "The name of the runtime to use. Currently, the only allowed value is\n APPSYNC_JS.
The version of the runtime to use. Currently, the only allowed version is\n 1.0.0.
Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync\n function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must\n also be specified.
" - } - }, - "com.amazonaws.appsync#AssociateApi": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#AssociateApiRequest" - }, - "output": { - "target": "com.amazonaws.appsync#AssociateApiResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-north-1.amazonaws.com" } - ], - "traits": { - "smithy.api#documentation": "Maps an endpoint to your custom domain.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/domainnames/{domainName}/apiassociation", - "code": 200 + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-south-1.amazonaws.com" } - } - }, - "com.amazonaws.appsync#AssociateApiRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.appsync#DomainName", - "traits": { - "smithy.api#documentation": "The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID. Private APIs can not be associated with custom domains.
", - "smithy.api#required": {} - } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-west-1.amazonaws.com" } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#AssociateApiResponse": { - "type": "structure", - "members": { - "apiAssociation": { - "target": "com.amazonaws.appsync#ApiAssociation", - "traits": { - "smithy.api#documentation": "The ApiAssociation object.
Creates an association between a Merged API and source API using the source API's identifier.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations", - "code": 200 + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-east-1.amazonaws.com" } - } - }, - "com.amazonaws.appsync#AssociateMergedGraphqlApiRequest": { - "type": "structure", - "members": { - "sourceApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "mergedApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description field.
" - } - }, - "sourceApiAssociationConfig": { - "target": "com.amazonaws.appsync#SourceApiAssociationConfig", - "traits": { - "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
Creates an association between a Merged API and source API using the Merged API's identifier.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations", - "code": 200 + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-east-1.api.aws" } - } - }, - "com.amazonaws.appsync#AssociateSourceGraphqlApiRequest": { - "type": "structure", - "members": { - "mergedApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "sourceApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description field.
" - } - }, - "sourceApiAssociationConfig": { - "target": "com.amazonaws.appsync#SourceApiAssociationConfig", - "traits": { - "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
The authorization type that the HTTP endpoint requires.
\n\n AWS_IAM: The authorization type is Signature Version 4\n (SigV4).
\nThe Identity and Access Management (IAM) settings.
" - } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.cn-north-1.api.amazonwebservices.com.cn" } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "traits": { - "smithy.api#documentation": "The authorization configuration in case the HTTP endpoint requires authorization.
" - } - }, - "com.amazonaws.appsync#AuthorizationType": { - "type": "enum", - "members": { - "AWS_IAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_IAM" - } + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-gov-east-1.api.aws" } - } - }, - "com.amazonaws.appsync#AwsIamConfig": { - "type": "structure", - "members": { - "signingRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The signing Amazon Web Services Region for IAM authorization.
" - } - }, - "signingServiceName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The signing service name for IAM authorization.
" - } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-gov-east-1.amazonaws.com" } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "The Identity and Access Management (IAM) configuration.
" - } - }, - "com.amazonaws.appsync#BadRequestDetail": { - "type": "structure", - "members": { - "codeErrors": { - "target": "com.amazonaws.appsync#CodeErrors", - "traits": { - "smithy.api#documentation": "Contains the list of errors in the request.
" - } + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-gov-east-1.api.aws" } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "traits": { - "smithy.api#documentation": "Provides further details for the reason behind the bad request. For reason type CODE_ERROR, the\n detail will contain a list of code errors.
The request is not well formed. For example, a value is invalid or a required field is missing. Check the\n field values, and then try again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appsync#BadRequestReason": { - "type": "enum", - "members": { - "CODE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CODE_ERROR" - } + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-iso-east-1.c2s.ic.gov" } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "Provides context for the cause of the bad request. The only supported value is\n CODE_ERROR.
The TTL in seconds for a resolver that has caching activated.
\nValid values are 1–3,600 seconds.
", - "smithy.api#required": {} - } - }, - "cachingKeys": { - "target": "com.amazonaws.appsync#CachingKeys", - "traits": { - "smithy.api#documentation": "The caching keys for a resolver that has caching activated.
\nValid values are entries from the $context.arguments, $context.source, and\n $context.identity maps.
The caching configuration for a resolver that has caching activated.
" - } - }, - "com.amazonaws.appsync#CachingKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#CertificateArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[a-z-]*:(acm|iam):[a-z0-9-]*:\\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$" - } - }, - "com.amazonaws.appsync#Code": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32768 - } - } - }, - "com.amazonaws.appsync#CodeError": { - "type": "structure", - "members": { - "errorType": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type of code error.
\nExamples include, but aren't limited to: LINT_ERROR, PARSER_ERROR.
A user presentable error.
\nExamples include, but aren't limited to: Parsing error: Unterminated string literal.
The line, column, and span location of the error in the code.
" - } + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-iso-east-1.c2s.ic.gov" } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "Describes an AppSync error.
" - } - }, - "com.amazonaws.appsync#CodeErrorColumn": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.appsync#CodeErrorLine": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.appsync#CodeErrorLocation": { - "type": "structure", - "members": { - "line": { - "target": "com.amazonaws.appsync#CodeErrorLine", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The line number in the code. Defaults to 0 if unknown.
The column number in the code. Defaults to 0 if unknown.
The span/length of the error. Defaults to -1 if unknown.
Describes the location of the error in a code sample.
" - } - }, - "com.amazonaws.appsync#CodeErrorSpan": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.appsync#CodeErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#CodeError" - } - }, - "com.amazonaws.appsync#CognitoUserPoolConfig": { - "type": "structure", - "members": { - "userPoolId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The user pool ID.
", - "smithy.api#required": {} - } - }, - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Region in which the user pool was created.
", - "smithy.api#required": {} - } - }, - "appIdClientRegex": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value\n isn't set, no filtering is applied.
" - } + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-isob-east-1.sc2s.sgov.gov" } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" - } - }, - "com.amazonaws.appsync#ConcurrentModificationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#ErrorMessage" - } + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "traits": { - "smithy.api#documentation": "Another modification is in progress at this time and it must complete before you can make your\n change.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.appsync#ConflictDetectionType": { - "type": "enum", - "members": { - "VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERSION" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.appsync#ConflictHandlerType": { - "type": "enum", - "members": { - "OPTIMISTIC_CONCURRENCY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OPTIMISTIC_CONCURRENCY" - } - }, - "LAMBDA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAMBDA" - } - }, - "AUTOMERGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTOMERGE" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-isob-east-1.sc2s.sgov.gov" } - } - }, - "com.amazonaws.appsync#Context": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 28000 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.appsync#CreateApiCache": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#CreateApiCacheRequest" - }, - "output": { - "target": "com.amazonaws.appsync#CreateApiCacheResponse" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a cache for the GraphQL API.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/ApiCaches", - "code": 200 - } - } - }, - "com.amazonaws.appsync#CreateApiCacheRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ttl": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
", - "smithy.api#required": {} - } - }, - "transitEncryptionEnabled": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Transit encryption flag when connecting to cache. You cannot update this setting after creation.
" - } - }, - "atRestEncryptionEnabled": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "At-rest encryption flag for cache. You cannot update this setting after creation.
" - } - }, - "apiCachingBehavior": { - "target": "com.amazonaws.appsync#ApiCachingBehavior", - "traits": { - "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nThe cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
Represents the input of a CreateApiCache operation.
The ApiCache object.
Represents the output of a CreateApiCache operation.
Creates a unique key that you can distribute to clients who invoke your API.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/apikeys", - "code": 200 - } - } - }, - "com.amazonaws.appsync#CreateApiKeyRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID for your GraphQL API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "A description of the purpose of the API key.
" - } - }, - "expires": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "From the creation time, the time after which the API key expires. The date is represented as seconds since\n the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time.\n For more information, see .
" - } - } + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#CreateApiKeyResponse": { - "type": "structure", - "members": { - "apiKey": { - "target": "com.amazonaws.appsync#ApiKey", - "traits": { - "smithy.api#documentation": "The API key.
" - } - } + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#output": {} + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.appsync#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "You don't have access to perform this operation on this resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.appsync#AdditionalAuthenticationProvider": { + "type": "structure", + "members": { + "authenticationType": { + "target": "com.amazonaws.appsync#AuthenticationType", + "traits": { + "smithy.api#documentation": "The authentication type: API key, Identity and Access Management (IAM), OpenID\n Connect (OIDC), Amazon Cognito user pools, or Lambda.
" + } + }, + "openIDConnectConfig": { + "target": "com.amazonaws.appsync#OpenIDConnectConfig", + "traits": { + "smithy.api#documentation": "The OIDC configuration.
" + } + }, + "userPoolConfig": { + "target": "com.amazonaws.appsync#CognitoUserPoolConfig", + "traits": { + "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" + } + }, + "lambdaAuthorizerConfig": { + "target": "com.amazonaws.appsync#LambdaAuthorizerConfig", + "traits": { + "smithy.api#documentation": "Configuration for Lambda function authorization.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an additional authentication provider.
" + } + }, + "com.amazonaws.appsync#AdditionalAuthenticationProviders": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#AdditionalAuthenticationProvider" + } + }, + "com.amazonaws.appsync#Api": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Api ID.
The name of the Api.
The owner contact information for the Api\n
The DNS records for the API. This will include an HTTP and a real-time endpoint.
" + } + }, + "apiArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the Api.
The date and time that the Api was created.
A flag indicating whether to use X-Ray tracing for this\n Api.
The Amazon Resource Name (ARN) of the WAF web access control list (web\n ACL) associated with this Api, if one exists.
The Event API configuration. This includes the default authorization configuration for\n connecting, publishing, and subscribing to an Event API.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an AppSync API. You can use Api for an AppSync\n API with your preferred configuration, such as an Event API that provides real-time message\n publishing and message subscriptions over WebSockets.
The domain name.
" + } + }, + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
" + } + }, + "associationStatus": { + "target": "com.amazonaws.appsync#AssociationStatus", + "traits": { + "smithy.api#documentation": "Identifies the status of an association.
\n\n PROCESSING: The API association is being\n created. You cannot modify association requests during processing.
\n\n SUCCESS: The API association was successful.\n You can modify associations after success.
\n\n FAILED: The API association has failed. You\n can modify associations after failure.
\nDetails about the last deployment status.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an ApiAssociation object.
TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
" + } + }, + "apiCachingBehavior": { + "target": "com.amazonaws.appsync#ApiCachingBehavior", + "traits": { + "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully\n cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers\n that you specify are cached.
\nTransit encryption flag when connecting to cache. You cannot update this setting after\n creation.
" + } + }, + "atRestEncryptionEnabled": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "At-rest encryption flag for cache. You cannot update this setting after creation.
" + } + }, + "type": { + "target": "com.amazonaws.appsync#ApiCacheType", + "traits": { + "smithy.api#documentation": "The cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nThe cache instance status.
\n\n AVAILABLE: The instance is available for\n use.
\n\n CREATING: The instance is currently\n creating.
\n\n DELETING: The instance is currently\n deleting.
\n\n MODIFYING: The instance is currently\n modifying.
\n\n FAILED: The instance has failed\n creation.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics\n include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the\n throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing\n bottlenecks in a cache configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis\n process. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
The ApiCache object.
The API key ID.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A description of the purpose of the API key.
" + } + }, + "expires": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The time after which the API key expires. The date is represented as seconds since the\n epoch, rounded down to the nearest hour.
" + } + }, + "deletes": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The time after which the API key is deleted. The date is represented as seconds since\n the epoch, rounded down to the nearest hour.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an API key.
\nCustomers invoke AppSync GraphQL API operations with API keys as an\n identity mechanism. There are two key versions:
\n\n da1: We introduced this version at launch in November\n 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key\n expiration. These keys ceased to be valid after February 21, 2018, and they should no\n longer be used.
\n\n ListApiKeys returns the expiration time in milliseconds.
\n CreateApiKey returns the expiration time in\n milliseconds.
\n UpdateApiKey is not available for this key version.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as milliseconds. This results in a\n bug where keys are not automatically deleted because DynamoDB expects the\n TTL to be stored in seconds. As a one-time action, we deleted these keys from the\n table on February 21, 2018.
\n\n da2: We introduced this version in February 2018 when\n AppSync added support to extend key expiration.
\n\n ListApiKeys returns the expiration time and deletion time in\n seconds.
\n CreateApiKey returns the expiration time and deletion time in\n seconds and accepts a user-provided expiration time in seconds.
\n UpdateApiKey returns the expiration time and and deletion time in\n seconds and accepts a user-provided expiration time in seconds. Expired API keys are\n kept for 60 days after the expiration time. You can update the key expiration time as\n long as the key isn't deleted.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as seconds. After the expiration\n time, using the key to authenticate will fail. However, you can reinstate the key\n before deletion.
\nDeletion is stored in DynamoDB as seconds. The key is deleted after\n deletion time.
\nThe API key exceeded a limit. Try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appsync#ApiKeyValidityOutOfBoundsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "The API key expiration must be set to a value between 1 and 365 days from creation (for\n CreateApiKey) or from update (for UpdateApiKey).
The GraphQL API exceeded a limit. Try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appsync#ApiName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[A-Za-z0-9_\\-\\ ]+$" + } + }, + "com.amazonaws.appsync#Apis": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#Api" + } + }, + "com.amazonaws.appsync#AppSyncRuntime": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#RuntimeName", + "traits": { + "smithy.api#documentation": "The name of the runtime to use. Currently, the only allowed value is\n APPSYNC_JS.
The version of the runtime to use. Currently, the only allowed version is\n 1.0.0.
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\n that if a runtime is specified, code must also be specified.
" + } + }, + "com.amazonaws.appsync#AssociateApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#AssociateApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#AssociateApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Maps an endpoint to your custom domain.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/domainnames/{domainName}/apiassociation", + "code": 200 + } + } + }, + "com.amazonaws.appsync#AssociateApiRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID. Private APIs can not be associated with custom domains.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#AssociateApiResponse": { + "type": "structure", + "members": { + "apiAssociation": { + "target": "com.amazonaws.appsync#ApiAssociation", + "traits": { + "smithy.api#documentation": "The ApiAssociation object.
Creates an association between a Merged API and source API using the source API's\n identifier.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations", + "code": 200 + } + } + }, + "com.amazonaws.appsync#AssociateMergedGraphqlApiRequest": { + "type": "structure", + "members": { + "sourceApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In\n most cases, source APIs (especially in your account) only require the API ID value or ARN\n of the source API. However, source APIs from other accounts (cross-account use cases)\n strictly require the full resource ARN of the source API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "mergedApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description field.
" + } + }, + "sourceApiAssociationConfig": { + "target": "com.amazonaws.appsync#SourceApiAssociationConfig", + "traits": { + "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
Creates an association between a Merged API and source API using the Merged API's\n identifier.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations", + "code": 200 + } + } + }, + "com.amazonaws.appsync#AssociateSourceGraphqlApiRequest": { + "type": "structure", + "members": { + "mergedApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sourceApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In\n most cases, source APIs (especially in your account) only require the API ID value or ARN\n of the source API. However, source APIs from other accounts (cross-account use cases)\n strictly require the full resource ARN of the source API.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description field.
" + } + }, + "sourceApiAssociationConfig": { + "target": "com.amazonaws.appsync#SourceApiAssociationConfig", + "traits": { + "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
The authorization type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an authorization configuration. Use AuthMode to specify the\n publishing and subscription authorization configuration for an Event API.
The authorization type.
", + "smithy.api#required": {} + } + }, + "cognitoConfig": { + "target": "com.amazonaws.appsync#CognitoConfig", + "traits": { + "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" + } + }, + "openIDConnectConfig": { + "target": "com.amazonaws.appsync#OpenIDConnectConfig" + }, + "lambdaAuthorizerConfig": { + "target": "com.amazonaws.appsync#LambdaAuthorizerConfig" + } + }, + "traits": { + "smithy.api#documentation": "Describes an authorization provider.
" + } + }, + "com.amazonaws.appsync#AuthProviders": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#AuthProvider" + } + }, + "com.amazonaws.appsync#AuthenticationType": { + "type": "enum", + "members": { + "API_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_KEY" + } + }, + "AWS_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IAM" + } + }, + "AMAZON_COGNITO_USER_POOLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_COGNITO_USER_POOLS" + } + }, + "OPENID_CONNECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENID_CONNECT" + } + }, + "AWS_LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_LAMBDA" + } + } + } + }, + "com.amazonaws.appsync#AuthorizationConfig": { + "type": "structure", + "members": { + "authorizationType": { + "target": "com.amazonaws.appsync#AuthorizationType", + "traits": { + "smithy.api#documentation": "The authorization type that the HTTP endpoint requires.
\n\n AWS_IAM: The authorization type is Signature\n Version 4 (SigV4).
\nThe Identity and Access Management (IAM) settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The authorization configuration in case the HTTP endpoint requires authorization.
" + } + }, + "com.amazonaws.appsync#AuthorizationType": { + "type": "enum", + "members": { + "AWS_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IAM" + } + } + } + }, + "com.amazonaws.appsync#AwsIamConfig": { + "type": "structure", + "members": { + "signingRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The signing Amazon Web Services Region for IAM authorization.
" + } + }, + "signingServiceName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The signing service name for IAM authorization.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Identity and Access Management (IAM) configuration.
" + } + }, + "com.amazonaws.appsync#BadRequestDetail": { + "type": "structure", + "members": { + "codeErrors": { + "target": "com.amazonaws.appsync#CodeErrors", + "traits": { + "smithy.api#documentation": "Contains the list of errors in the request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides further details for the reason behind the bad request. For reason type\n CODE_ERROR, the detail will contain a list of code errors.
Creates a DataSource object.
The API ID for the GraphQL API for the DataSource.
A user-supplied name for the DataSource.
A description of the DataSource.
The type of the DataSource.
The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.\n The system assumes this role when accessing the data source.
" - } - }, - "dynamodbConfig": { - "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon DynamoDB settings.
" - } - }, - "lambdaConfig": { - "target": "com.amazonaws.appsync#LambdaDataSourceConfig", - "traits": { - "smithy.api#documentation": "Lambda settings.
" - } - }, - "elasticsearchConfig": { - "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon OpenSearch Service settings.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to\n create an OpenSearch data source.
" - } - }, - "openSearchServiceConfig": { - "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon OpenSearch Service settings.
" - } - }, - "httpConfig": { - "target": "com.amazonaws.appsync#HttpDataSourceConfig", - "traits": { - "smithy.api#documentation": "HTTP endpoint settings.
" - } - }, - "relationalDatabaseConfig": { - "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", - "traits": { - "smithy.api#documentation": "Relational database settings.
" - } - }, - "eventBridgeConfig": { - "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon EventBridge settings.
" - } - }, - "metricsConfig": { - "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", - "traits": { - "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The DataSource object.
Creates a custom DomainName object.
The domain name.
", - "smithy.api#required": {} - } - }, - "certificateArn": { - "target": "com.amazonaws.appsync#CertificateArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#Description", - "traits": { - "smithy.api#documentation": "A description of the DomainName.
The configuration for the DomainName.
Creates a Function object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/functions", - "code": 200 - } - } - }, - "com.amazonaws.appsync#CreateFunctionRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The Function name. The function name does not have to be unique.
The Function description.
The Function\n DataSource name.
The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function response mapping template.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note\n that when using VTL and mapping templates, the functionVersion is required.
The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The Function object.
Creates a GraphqlApi object.
A user-supplied name for the GraphqlApi.
The Amazon CloudWatch Logs configuration.
" - } - }, - "authenticationType": { - "target": "com.amazonaws.appsync#AuthenticationType", - "traits": { - "smithy.api#documentation": "The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),\n Amazon Cognito user pools, or Lambda.
", - "smithy.api#required": {} - } - }, - "userPoolConfig": { - "target": "com.amazonaws.appsync#UserPoolConfig", - "traits": { - "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" - } - }, - "openIDConnectConfig": { - "target": "com.amazonaws.appsync#OpenIDConnectConfig", - "traits": { - "smithy.api#documentation": "The OIDC configuration.
" - } - }, - "tags": { - "target": "com.amazonaws.appsync#TagMap", - "traits": { - "smithy.api#documentation": "A TagMap object.
A list of additional authentication providers for the GraphqlApi API.
A flag indicating whether to use X-Ray tracing for the GraphqlApi.
Configuration for Lambda function authorization.
" - } - }, - "visibility": { - "target": "com.amazonaws.appsync#GraphQLApiVisibility", - "traits": { - "smithy.api#documentation": "Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no\n value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed\n once the API has been created.
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" - } - }, - "introspectionConfig": { - "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", - "traits": { - "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" - } - }, - "queryDepthLimit": { - "target": "com.amazonaws.appsync#QueryDepthLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" - } - }, - "resolverCountLimit": { - "target": "com.amazonaws.appsync#ResolverCountLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The enhancedMetricsConfig object.
The GraphqlApi.
Creates a Resolver object.
A resolver converts incoming requests into a format that a data source can understand, and converts the data\n source's responses into GraphQL.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", - "code": 200 - } - } - }, - "com.amazonaws.appsync#CreateResolverRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID for the GraphQL API for which the resolver is being created.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the Type.
The name of the field to attach the resolver to.
", - "smithy.api#required": {} - } - }, - "dataSourceName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the data source for which the resolver is being created.
" - } - }, - "requestMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The mapping template to use for requests.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format that a data source\n can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data source. For all other\n data sources, VTL request and response mapping templates are required.
" - } - }, - "responseMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The mapping template to use for responses from the data source.
" - } - }, - "kind": { - "target": "com.amazonaws.appsync#ResolverKind", - "traits": { - "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" - } - }, - "maxBatchSize": { - "target": "com.amazonaws.appsync#MaxBatchSize", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The Resolver object.
Creates a Type object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type definition, in GraphQL Schema Definition Language (SDL) format.
\nFor more information, see the GraphQL SDL\n documentation.
", - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The type format: SDL or JSON.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#CreateTypeResponse": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.appsync#Type", - "traits": { - "smithy.api#documentation": "The Type object.
The data source Amazon Resource Name (ARN).
" - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the data source.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description of the data source.
" - } - }, - "type": { - "target": "com.amazonaws.appsync#DataSourceType", - "traits": { - "smithy.api#documentation": "The type of the data source.
\n\n AWS_LAMBDA: The data source is an Lambda\n function.
\n\n AMAZON_DYNAMODB: The data source is an Amazon DynamoDB\n table.
\n\n AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service\n domain.
\n\n AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
\n\n AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge\n configuration.
\n\n NONE: There is no data source. Use this type when you want to\n invoke a GraphQL operation without connecting to a data source, such as when you're performing data\n transformation with resolvers or invoking a subscription from a mutation.
\n\n HTTP: The data source is an HTTP endpoint.
\n\n RELATIONAL_DATABASE: The data source is a relational\n database.
\nThe Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.\n The system assumes this role when accessing the data source.
" - } - }, - "dynamodbConfig": { - "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", - "traits": { - "smithy.api#documentation": "DynamoDB settings.
" - } - }, - "lambdaConfig": { - "target": "com.amazonaws.appsync#LambdaDataSourceConfig", - "traits": { - "smithy.api#documentation": "Lambda settings.
" - } - }, - "elasticsearchConfig": { - "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon OpenSearch Service settings.
" - } - }, - "openSearchServiceConfig": { - "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon OpenSearch Service settings.
" - } - }, - "httpConfig": { - "target": "com.amazonaws.appsync#HttpDataSourceConfig", - "traits": { - "smithy.api#documentation": "HTTP endpoint settings.
" - } - }, - "relationalDatabaseConfig": { - "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", - "traits": { - "smithy.api#documentation": "Relational database settings.
" - } - }, - "eventBridgeConfig": { - "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon EventBridge settings.
" - } - }, - "metricsConfig": { - "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", - "traits": { - "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Describes a data source.
" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModel": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The name of the model. For example, this could be the name of a single table in a database.
" - } - }, - "fields": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModelFields", - "traits": { - "smithy.api#documentation": "The DataSourceIntrospectionModelField object data.
The primary key stored as a DataSourceIntrospectionModelIndex object.
The array of DataSourceIntrospectionModelIndex objects.
Contains the output of the SDL that was generated from the introspected types. This is controlled by the\n includeModelsSDL parameter of the GetDataSourceIntrospection operation.
Contains the introspected data that was retrieved from the data source.
" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelField": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The name of the field that was retrieved from the introspected data.
" - } - }, - "type": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModelFieldType", - "traits": { - "smithy.api#documentation": "The DataSourceIntrospectionModelFieldType object data.
The length value of the introspected field.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the fields that were retrieved from the introspected data.
" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelFieldType": { - "type": "structure", - "members": { - "kind": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Specifies the classification of data. For example, this could be set to values like Scalar or\n NonNull to indicate a fundamental property of the field.
Valid values include:
\n\n Scalar: Indicates the value is a primitive type (scalar).
\n NonNull: Indicates the field cannot be null.
\n List: Indicates the field contains a list.
The name of the data type that represents the field. For example, String is a valid\n name value.
The DataSourceIntrospectionModelFieldType object data. The type is only present if\n DataSourceIntrospectionModelFieldType.kind is set to NonNull or List.
The type typically contains its own kind and name fields to represent\n the actual type data. For instance, type could contain a kind value of\n Scalar with a name value of String. The values Scalar\n and String will be collectively stored in the values field.
The values of the type field. This field represents the AppSync data type equivalent of the\n introspected field.
Represents the type data for each field retrieved from the introspection.
" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelFieldTypeValues": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelFields": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModelField" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelIndex": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The name of the index.
" - } - }, - "fields": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModelIndexFields", - "traits": { - "smithy.api#documentation": "The fields of the index.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The index that was retrieved from the introspected data.
" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelIndexFields": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelIndexes": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModelIndex" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModels": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModel" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionResult": { - "type": "structure", - "members": { - "models": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModels", - "traits": { - "smithy.api#documentation": "The array of DataSourceIntrospectionModel objects.
Determines the number of types to be returned in a single response before paginating. This value is\n typically taken from nextToken value from the previous response.
Represents the output of a DataSourceIntrospectionResult. This is the populated result of a\n GetDataSourceIntrospection operation.
Deletes an ApiCache object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the input of a DeleteApiCache operation.
Represents the output of a DeleteApiCache operation.
Deletes an API key.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/v1/apis/{apiId}/apikeys/{id}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#DeleteApiKeyRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID for the API key.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteApiKeyResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeleteDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DeleteDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DeleteDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a DataSource object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteDataSourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeleteDomainName": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DeleteDomainNameRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DeleteDomainNameResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a custom DomainName object.
The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteDomainNameResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeleteFunction": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DeleteFunctionRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DeleteFunctionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a Function.
The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "functionId": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The Function ID.
Deletes a GraphqlApi object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteGraphqlApiResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeleteResolver": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DeleteResolverRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DeleteResolverResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a Resolver object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the resolver type.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "fieldName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver field name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteResolverResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeleteType": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DeleteTypeRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DeleteTypeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a Type object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteTypeResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeltaSyncConfig": { - "type": "structure", - "members": { - "baseTableTTL": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of minutes that an Item is stored in the data source.
" - } - }, - "deltaSyncTableName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Delta Sync table name.
" - } - }, - "deltaSyncTableTTL": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a Delta Sync configuration.
" - } - }, - "com.amazonaws.appsync#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.appsync#DisassociateApi": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DisassociateApiRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DisassociateApiResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Removes an ApiAssociation object from a custom domain.
The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DisassociateApiResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DisassociateMergedGraphqlApi": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DisassociateMergedGraphqlApiRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DisassociateMergedGraphqlApiResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an association between a Merged API and source API using the source API's identifier and the\n association ID.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations/{associationId}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#DisassociateMergedGraphqlApiRequest": { - "type": "structure", - "members": { - "sourceApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DisassociateMergedGraphqlApiResponse": { - "type": "structure", - "members": { - "sourceApiAssociationStatus": { - "target": "com.amazonaws.appsync#SourceApiAssociationStatus", - "traits": { - "smithy.api#documentation": "The state of the source API association.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DisassociateSourceGraphqlApi": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DisassociateSourceGraphqlApiRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DisassociateSourceGraphqlApiResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an association between a Merged API and source API using the Merged API's identifier and the\n association ID.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#DisassociateSourceGraphqlApiRequest": { - "type": "structure", - "members": { - "mergedApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DisassociateSourceGraphqlApiResponse": { - "type": "structure", - "members": { - "sourceApiAssociationStatus": { - "target": "com.amazonaws.appsync#SourceApiAssociationStatus", - "traits": { - "smithy.api#documentation": "The state of the source API association.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DomainName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 253 - }, - "smithy.api#pattern": "^(\\*[\\w\\d-]*\\.)?([\\w\\d-]+\\.)+[\\w\\d-]+$" - } - }, - "com.amazonaws.appsync#DomainNameConfig": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.appsync#DomainName", - "traits": { - "smithy.api#documentation": "The domain name.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#Description", - "traits": { - "smithy.api#documentation": "A description of the DomainName configuration.
The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
" - } - }, - "appsyncDomainName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The domain name that AppSync provides.
" - } - }, - "hostedZoneId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of your Amazon Route 53 hosted zone.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a configuration for a custom domain.
" - } - }, - "com.amazonaws.appsync#DomainNameConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#DomainNameConfig" - } - }, - "com.amazonaws.appsync#DynamodbDataSourceConfig": { - "type": "structure", - "members": { - "tableName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The table name.
", - "smithy.api#required": {} - } - }, - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Region.
", - "smithy.api#required": {} - } - }, - "useCallerCredentials": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Set to TRUE to use Amazon Cognito credentials with this data source.
" - } - }, - "deltaSyncConfig": { - "target": "com.amazonaws.appsync#DeltaSyncConfig", - "traits": { - "smithy.api#documentation": "The DeltaSyncConfig for a versioned data source.
Set to TRUE to use Conflict Detection and Resolution with this data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an Amazon DynamoDB data source configuration.
" - } - }, - "com.amazonaws.appsync#ElasticsearchDataSourceConfig": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The endpoint.
", - "smithy.api#required": {} - } - }, - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Region.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an OpenSearch data source configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source.
" - } - }, - "com.amazonaws.appsync#EnhancedMetricsConfig": { - "type": "structure", - "members": { - "resolverLevelMetricsBehavior": { - "target": "com.amazonaws.appsync#ResolverLevelMetricsBehavior", - "traits": { - "smithy.api#documentation": "Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
\nGraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be\n recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at\n a time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the\n request.
\n PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the\n metricsConfig value set to ENABLED.
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
\nRequests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics\n will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of\n these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources\n in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the\n metricsConfig value set to ENABLED.
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
\nRequests: The number of times a specified GraphQL operation was called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to ENABLED or\n DISABLED.
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and\n performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data\n is sent to your CloudWatch account, and you can configure the types of data that will be sent.
\nEnhanced metrics can be configured at the resolver, data source, and operation levels.\n EnhancedMetricsConfig contains three required parameters, each controlling one of these\n categories:
\n resolverLevelMetricsBehavior: Controls how resolver metrics will be emitted to\n CloudWatch. Resolver metrics include:
GraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics\n will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of\n these values at a time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers\n in the request.
\n PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the\n metricsConfig value set to ENABLED.
\n dataSourceLevelMetricsBehavior: Controls how data source metrics will be emitted to\n CloudWatch. Data source metrics include:
Requests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request.\n Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior\n accepts one of these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data\n sources in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that\n have the metricsConfig value set to ENABLED.
\n operationLevelMetricsConfig: Controls how operation metrics will be emitted to\n CloudWatch. Operation metrics include:
Requests: The number of times a specified GraphQL operation was called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to ENABLED\n or DISABLED.
The error payload.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the list of errors generated. When using JavaScript, this will apply to the request or response\n function evaluation.
" - } - }, - "com.amazonaws.appsync#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.appsync#EvaluateCode": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#EvaluateCodeRequest" - }, - "output": { - "target": "com.amazonaws.appsync#EvaluateCodeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - } - ], - "traits": { - "smithy.api#documentation": "Evaluates the given code and returns the response. The code definition requirements depend on the specified\n runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request\n function takes the incoming request after a GraphQL operation is parsed and converts it into a request\n configuration for the selected data source operation. The response function interprets responses from the data\n source and maps it to the shape of the GraphQL field output type.
The error payload.
" - } - }, - "codeErrors": { - "target": "com.amazonaws.appsync#CodeErrors", - "traits": { - "smithy.api#documentation": "Contains the list of CodeError objects.
Contains the list of errors from a code evaluation response.
" - } - }, - "com.amazonaws.appsync#EvaluateCodeRequest": { - "type": "structure", - "members": { - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime", - "traits": { - "smithy.api#documentation": "The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is\n supported.
The code definition to be evaluated. Note that code and runtime are both required\n for this action. The runtime value must be APPSYNC_JS.
The map that holds all of the contextual information for your resolver invocation. A context is\n required for this action.
The function within the code to be evaluated. If provided, the valid values are request and\n response.
The result of the evaluation operation.
" - } - }, - "error": { - "target": "com.amazonaws.appsync#EvaluateCodeErrorDetail", - "traits": { - "smithy.api#documentation": "Contains the payload of the response error.
" - } - }, - "logs": { - "target": "com.amazonaws.appsync#Logs", - "traits": { - "smithy.api#documentation": "A list of logs that were generated by calls to util.log.info and util.log.error in\n the evaluated code.
Evaluates a given template and returns the response. The mapping template can be a request or response\n template.
\nRequest templates take the incoming request after a GraphQL operation is parsed and convert it into a\n request configuration for the selected data source operation. Response templates interpret responses from the\n data source and map it to the shape of the GraphQL field output type.
\nMapping templates are written in the Apache Velocity Template Language (VTL).
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/dataplane-evaluatetemplate", - "code": 200 - } - } - }, - "com.amazonaws.appsync#EvaluateMappingTemplateRequest": { - "type": "structure", - "members": { - "template": { - "target": "com.amazonaws.appsync#Template", - "traits": { - "smithy.api#documentation": "The mapping template; this can be a request or response template. A template is required for\n this action.
The map that holds all of the contextual information for your resolver invocation. A context is\n required for this action.
The mapping template; this can be a request or response template.
" - } - }, - "error": { - "target": "com.amazonaws.appsync#ErrorDetail", - "traits": { - "smithy.api#documentation": "The ErrorDetail object.
A list of logs that were generated by calls to util.log.info and util.log.error in\n the evaluated code.
The ARN of the event bus. For more information about event buses, see Amazon EventBridge event\n buses.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an Amazon EventBridge bus data source configuration.
" - } - }, - "com.amazonaws.appsync#FieldLogLevel": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - }, - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - }, - "INFO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFO" - } - }, - "DEBUG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEBUG" - } - } - } - }, - "com.amazonaws.appsync#FlushApiCache": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#FlushApiCacheRequest" - }, - "output": { - "target": "com.amazonaws.appsync#FlushApiCacheResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Flushes an ApiCache object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the input of a FlushApiCache operation.
Represents the output of a FlushApiCache operation.
A unique ID representing the Function object.
The Amazon Resource Name (ARN) of the Function object.
The name of the Function object.
The Function description.
The name of the DataSource.
The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function response mapping template.
The version of the request mapping template. Currently, only the 2018-05-29 version of the template is\n supported.
" - } - }, - "syncConfig": { - "target": "com.amazonaws.appsync#SyncConfig" - }, - "maxBatchSize": { - "target": "com.amazonaws.appsync#MaxBatchSize", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
" - } - }, - "com.amazonaws.appsync#Functions": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#FunctionConfiguration" - } - }, - "com.amazonaws.appsync#FunctionsIds": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#GetApiAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#GetApiAssociationRequest" - }, - "output": { - "target": "com.amazonaws.appsync#GetApiAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves an ApiAssociation object.
The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetApiAssociationResponse": { - "type": "structure", - "members": { - "apiAssociation": { - "target": "com.amazonaws.appsync#ApiAssociation", - "traits": { - "smithy.api#documentation": "The ApiAssociation object.
Retrieves an ApiCache object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the input of a GetApiCache operation.
The ApiCache object.
Represents the output of a GetApiCache operation.
Retrieves a DataSource object.
Retrieves the record of an existing introspection. If the retrieval is successful, the result of the\n instrospection will also be returned. If the retrieval fails the operation, an error message will be returned\n instead.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/datasources/introspections/{introspectionId}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#GetDataSourceIntrospectionRequest": { - "type": "structure", - "members": { - "introspectionId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "includeModelsSDL": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "A boolean flag that determines whether SDL should be generated for introspected types or not. If set to\n true, each model will contain an sdl property that contains the SDL for that type.\n The SDL only contains the type data and no additional metadata or directives.
Determines the number of types to be returned in a single response before paginating. This value is\n typically taken from nextToken value from the previous response.
The maximum number of introspected types that will be returned in a single response.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetDataSourceIntrospectionResponse": { - "type": "structure", - "members": { - "introspectionId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
" - } - }, - "introspectionStatus": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionStatus", - "traits": { - "smithy.api#documentation": "The status of the introspection during retrieval. By default, when a new instrospection is being retrieved,\n the status will be set to PROCESSING. Once the operation has been completed, the status will\n change to SUCCESS or FAILED depending on how the data was parsed. A\n FAILED operation will return an error and its details as an\n introspectionStatusDetail.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail will also return the\n exact error that was generated during the operation.
The DataSourceIntrospectionResult object data.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetDataSourceResponse": { - "type": "structure", - "members": { - "dataSource": { - "target": "com.amazonaws.appsync#DataSource", - "traits": { - "smithy.api#documentation": "The DataSource object.
Retrieves a custom DomainName object.
The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetDomainNameResponse": { - "type": "structure", - "members": { - "domainNameConfig": { - "target": "com.amazonaws.appsync#DomainNameConfig", - "traits": { - "smithy.api#documentation": "The configuration for the DomainName.
Get a Function.
The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "functionId": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The Function ID.
The Function object.
Retrieves a GraphqlApi object.
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/environmentVariables", - "code": 200 - } - } - }, - "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariablesRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of the API from which the environmental variable list will be retrieved.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariablesResponse": { - "type": "structure", - "members": { - "environmentVariables": { - "target": "com.amazonaws.appsync#EnvironmentVariableMap", - "traits": { - "smithy.api#documentation": "The payload containing each environmental variable in the \"key\" : \"value\" format.
The API ID for the GraphQL API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetGraphqlApiResponse": { - "type": "structure", - "members": { - "graphqlApi": { - "target": "com.amazonaws.appsync#GraphqlApi", - "traits": { - "smithy.api#documentation": "The GraphqlApi object.
Retrieves the introspection schema for a GraphQL API.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/schema", - "code": 200 - } - } - }, - "com.amazonaws.appsync#GetIntrospectionSchemaRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.appsync#OutputType", - "traits": { - "smithy.api#documentation": "The schema format: SDL or JSON.
", - "smithy.api#httpQuery": "format", - "smithy.api#required": {} - } - }, - "includeDirectives": { - "target": "com.amazonaws.appsync#BooleanValue", - "traits": { - "smithy.api#documentation": "A flag that specifies whether the schema introspection should contain directives.
", - "smithy.api#httpQuery": "includeDirectives" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetIntrospectionSchemaResponse": { - "type": "structure", - "members": { - "schema": { - "target": "com.amazonaws.appsync#Blob", - "traits": { - "smithy.api#documentation": "The schema, in GraphQL Schema Definition Language (SDL) format.
\nFor more information, see the GraphQL SDL\n documentation.
", - "smithy.api#httpPayload": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#GetResolver": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#GetResolverRequest" - }, - "output": { - "target": "com.amazonaws.appsync#GetResolverResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a Resolver object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "fieldName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver field name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetResolverResponse": { - "type": "structure", - "members": { - "resolver": { - "target": "com.amazonaws.appsync#Resolver", - "traits": { - "smithy.api#documentation": "The Resolver object.
Retrieves the current status of a schema creation operation.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/schemacreation", - "code": 200 - } - } - }, - "com.amazonaws.appsync#GetSchemaCreationStatusRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetSchemaCreationStatusResponse": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.appsync#SchemaStatus", - "traits": { - "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the\n ACTIVE state, you can add data.
" - } - }, - "details": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Detailed information about the status of the schema creation operation.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#GetSourceApiAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#GetSourceApiAssociationRequest" - }, - "output": { - "target": "com.amazonaws.appsync#GetSourceApiAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a SourceApiAssociation object.
The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetSourceApiAssociationResponse": { - "type": "structure", - "members": { - "sourceApiAssociation": { - "target": "com.amazonaws.appsync#SourceApiAssociation", - "traits": { - "smithy.api#documentation": "The SourceApiAssociation object data.
Retrieves a Type object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The type format: SDL or JSON.
", - "smithy.api#httpQuery": "format", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetTypeResponse": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.appsync#Type", - "traits": { - "smithy.api#documentation": "The Type object.
The GraphQL schema is not valid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appsync#GraphqlApi": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The API name.
" - } - }, - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
" - } - }, - "authenticationType": { - "target": "com.amazonaws.appsync#AuthenticationType", - "traits": { - "smithy.api#documentation": "The authentication type.
" - } - }, - "logConfig": { - "target": "com.amazonaws.appsync#LogConfig", - "traits": { - "smithy.api#documentation": "The Amazon CloudWatch Logs configuration.
" - } - }, - "userPoolConfig": { - "target": "com.amazonaws.appsync#UserPoolConfig", - "traits": { - "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" - } - }, - "openIDConnectConfig": { - "target": "com.amazonaws.appsync#OpenIDConnectConfig", - "traits": { - "smithy.api#documentation": "The OpenID Connect configuration.
" - } - }, - "arn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN).
" - } - }, - "uris": { - "target": "com.amazonaws.appsync#MapOfStringToString", - "traits": { - "smithy.api#documentation": "The URIs.
" - } - }, - "tags": { - "target": "com.amazonaws.appsync#TagMap", - "traits": { - "smithy.api#documentation": "The tags.
" - } - }, - "additionalAuthenticationProviders": { - "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", - "traits": { - "smithy.api#documentation": "A list of additional authentication providers for the GraphqlApi API.
A flag indicating whether to use X-Ray tracing for this GraphqlApi.
The ARN of the WAF access control list (ACL) associated with this\n GraphqlApi, if one exists.
Configuration for Lambda function authorization.
" - } - }, - "dns": { - "target": "com.amazonaws.appsync#MapOfStringToString", - "traits": { - "smithy.api#documentation": "The DNS records for the API.
" - } - }, - "visibility": { - "target": "com.amazonaws.appsync#GraphQLApiVisibility", - "traits": { - "smithy.api#documentation": "Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no\n value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed\n once the API has been created.
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The account owner of the GraphQL API.
" - } - }, - "ownerContact": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" - } - }, - "introspectionConfig": { - "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", - "traits": { - "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" - } - }, - "queryDepthLimit": { - "target": "com.amazonaws.appsync#QueryDepthLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" - } - }, - "resolverCountLimit": { - "target": "com.amazonaws.appsync#ResolverCountLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The enhancedMetricsConfig object.
Describes a GraphQL API.
" - } - }, - "com.amazonaws.appsync#GraphqlApis": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#GraphqlApi" - } - }, - "com.amazonaws.appsync#HttpDataSourceConfig": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL\n scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80\n for the HTTP endpoint and port 443 for HTTPS endpoints.
" - } - }, - "authorizationConfig": { - "target": "com.amazonaws.appsync#AuthorizationConfig", - "traits": { - "smithy.api#documentation": "The authorization configuration in case the HTTP endpoint requires authorization.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an HTTP data source configuration.
" - } - }, - "com.amazonaws.appsync#InternalFailureException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" - } - }, - "traits": { - "smithy.api#documentation": "An internal AppSync error occurred. Try your request again.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.appsync#LambdaAuthorizerConfig": { - "type": "structure", - "members": { - "authorizerResultTtlInSeconds": { - "target": "com.amazonaws.appsync#TTL", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If\n you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum\n value is one hour (3600 seconds). The Lambda function can override this by returning a\n ttlOverride key in its response.
The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can\n be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.
\n Note: This Lambda function must have the following\n resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is\n done for you. To use the Command Line Interface (CLI), run the following:
\n\n aws lambda add-permission --function-name\n \"arn:aws:lambda:us-east-2:111122223333:function:my-function\" --statement-id \"appsync\" --principal\n appsync.amazonaws.com --action lambda:InvokeFunction\n
A regular expression for validation of tokens before the Lambda function is called.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A LambdaAuthorizerConfig specifies how to authorize AppSync API access when\n using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only\n one Lambda authorizer configured at a time.
The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The LambdaConflictHandlerConfig object when configuring LAMBDA as the Conflict\n Handler.
The Amazon Resource Name (ARN) for the Lambda function.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an Lambda data source configuration.
" - } - }, - "com.amazonaws.appsync#LimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" - } - }, - "traits": { - "smithy.api#documentation": "The request exceeded a limit. Try your request again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.appsync#ListApiKeys": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListApiKeysRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListApiKeysResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the API keys for a given API.
\nAPI keys are deleted automatically 60 days after they expire. However, they may still be included in the\n response until they have actually been deleted. You can safely call DeleteApiKey to manually\n delete a key before it's automatically deleted.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListApiKeysResponse": { - "type": "structure", - "members": { - "apiKeys": { - "target": "com.amazonaws.appsync#ApiKeys", - "traits": { - "smithy.api#documentation": "The ApiKey objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListDataSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListDataSourcesRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListDataSourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the data sources for a given API.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/datasources", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "dataSources", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListDataSourcesRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListDataSourcesResponse": { - "type": "structure", - "members": { - "dataSources": { - "target": "com.amazonaws.appsync#DataSources", - "traits": { - "smithy.api#documentation": "The DataSource objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListDomainNames": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListDomainNamesRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListDomainNamesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - } - ], - "traits": { - "smithy.api#documentation": "Lists multiple custom domain names.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/domainnames", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "domainNameConfigs", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListDomainNamesRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListDomainNamesResponse": { - "type": "structure", - "members": { - "domainNameConfigs": { - "target": "com.amazonaws.appsync#DomainNameConfigs", - "traits": { - "smithy.api#documentation": "Lists configurations for multiple domain names.
" - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListFunctions": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListFunctionsRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListFunctionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "List multiple functions.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/functions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "functions", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListFunctionsRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListFunctionsResponse": { - "type": "structure", - "members": { - "functions": { - "target": "com.amazonaws.appsync#Functions", - "traits": { - "smithy.api#documentation": "A list of Function objects.
An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListGraphqlApis": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListGraphqlApisRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListGraphqlApisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists your GraphQL APIs.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "graphqlApis", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListGraphqlApisRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - }, - "apiType": { - "target": "com.amazonaws.appsync#GraphQLApiType", - "traits": { - "smithy.api#documentation": "The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The account owner of the GraphQL API.
", - "smithy.api#httpQuery": "owner" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListGraphqlApisResponse": { - "type": "structure", - "members": { - "graphqlApis": { - "target": "com.amazonaws.appsync#GraphqlApis", - "traits": { - "smithy.api#documentation": "The GraphqlApi objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListResolvers": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListResolversRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListResolversResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the resolvers for a given API and type.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "resolvers", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListResolversByFunction": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListResolversByFunctionRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListResolversByFunctionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "List the resolvers that are associated with a specific function.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/functions/{functionId}/resolvers", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "resolvers", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListResolversByFunctionRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "functionId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The function ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListResolversByFunctionResponse": { - "type": "structure", - "members": { - "resolvers": { - "target": "com.amazonaws.appsync#Resolvers", - "traits": { - "smithy.api#documentation": "The list of resolvers.
" - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that you can use to return the next set of items in the list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListResolversRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListResolversResponse": { - "type": "structure", - "members": { - "resolvers": { - "target": "com.amazonaws.appsync#Resolvers", - "traits": { - "smithy.api#documentation": "The Resolver objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListSourceApiAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListSourceApiAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListSourceApiAssociationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the SourceApiAssociationSummary data.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListSourceApiAssociationsResponse": { - "type": "structure", - "members": { - "sourceApiAssociationSummaries": { - "target": "com.amazonaws.appsync#SourceApiAssociationSummaryList", - "traits": { - "smithy.api#documentation": "The SourceApiAssociationSummary object data.
An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#LimitExceededException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the tags for a resource.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.appsync#ResourceArn", - "traits": { - "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A TagMap object.
Lists the types for a given API.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/types", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "types", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListTypesByAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListTypesByAssociationRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListTypesByAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists Type objects by the source API association ID.
The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The format type.
", - "smithy.api#httpQuery": "format", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListTypesByAssociationResponse": { - "type": "structure", - "members": { - "types": { - "target": "com.amazonaws.appsync#TypeList", - "traits": { - "smithy.api#documentation": "The Type objects.
An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListTypesRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The type format: SDL or JSON.
", - "smithy.api#httpQuery": "format", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListTypesResponse": { - "type": "structure", - "members": { - "types": { - "target": "com.amazonaws.appsync#TypeList", - "traits": { - "smithy.api#documentation": "The Type objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#LogConfig": { - "type": "structure", - "members": { - "fieldLogLevel": { - "target": "com.amazonaws.appsync#FieldLogLevel", - "traits": { - "smithy.api#documentation": "The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.
\n\n NONE: No field-level logs are captured.
\n\n ERROR: Logs the following information\n only for the fields that are in the error\n category:
\nThe error section in the server response.
\nField-level errors.
\nThe generated request/response functions that got resolved for error fields.
\n\n INFO: Logs the following information only for the fields that are in the info and error\n categories:
\nInfo-level messages.
\nThe user messages sent through $util.log.info and\n console.log.
Field-level tracing and mapping logs are not shown.
\n\n DEBUG: Logs the following information\n only for the fields that are in the debug, info,\n and error categories:
\nDebug-level messages.
\nThe user messages sent through $util.log.info,\n $util.log.debug, console.log, and\n console.debug.
Field-level tracing and mapping logs are not shown.
\n\n ALL: The following information is logged for all fields in the\n query:
\nField-level tracing information.
\nThe generated request/response functions that were resolved for each\n field.
\nThe service role that AppSync assumes to publish to CloudWatch logs in your\n account.
", - "smithy.api#required": {} - } - }, - "excludeVerboseContent": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping\n templates, regardless of logging level.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon CloudWatch Logs configuration.
" - } - }, - "com.amazonaws.appsync#Logs": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#Long": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.appsync#MapOfStringToString": { - "type": "map", - "key": { - "target": "com.amazonaws.appsync#String" - }, - "value": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#MappingTemplate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 65536 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.appsync#MaxBatchSize": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.appsync#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.appsync#MergeType": { - "type": "enum", - "members": { - "MANUAL_MERGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL_MERGE" - } - }, - "AUTO_MERGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO_MERGE" - } - } - } - }, - "com.amazonaws.appsync#NotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" - } - }, - "traits": { - "smithy.api#documentation": "The resource specified in the request was not found. Check the resource, and then try again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.appsync#OpenIDConnectConfig": { - "type": "structure", - "members": { - "issuer": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of\n iss in the ID token.
The client identifier of the relying party at the OpenID identity provider. This identifier is typically\n obtained when the relying party is registered with the OpenID identity provider. You can specify a regular\n expression so that AppSync can validate against multiple client identifiers at a time.
" - } - }, - "iatTTL": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of milliseconds that a token is valid after it's issued to a user.
" - } - }, - "authTTL": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of milliseconds that a token is valid after being authenticated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an OpenID Connect (OIDC) configuration.
" - } - }, - "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The endpoint.
", - "smithy.api#required": {} - } - }, - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Region.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an OpenSearch data source configuration.
" - } - }, - "com.amazonaws.appsync#OperationLevelMetricsConfig": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.appsync#OutputType": { - "type": "enum", - "members": { - "SDL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SDL" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - } - } - }, - "com.amazonaws.appsync#Ownership": { - "type": "enum", - "members": { - "CURRENT_ACCOUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CURRENT_ACCOUNT" - } - }, - "OTHER_ACCOUNTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER_ACCOUNTS" - } - } - } - }, - "com.amazonaws.appsync#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 65536 - }, - "smithy.api#pattern": "^[\\\\S]+$" - } - }, - "com.amazonaws.appsync#PipelineConfig": { - "type": "structure", - "members": { - "functions": { - "target": "com.amazonaws.appsync#FunctionsIds", - "traits": { - "smithy.api#documentation": "A list of Function objects.
The pipeline configuration for a resolver of kind PIPELINE.
Creates a list of environmental variables in an API by its ID value.
\nWhen creating an environmental variable, it must follow the constraints below:
\nBoth JavaScript and VTL templates support environmental variables.
\nEnvironmental variables are not evaluated before function invocation.
\nEnvironmental variables only support string values.
\nAny defined value in an environmental variable is considered a string literal and not\n expanded.
\nVariable evaluations should ideally be performed in the function code.
\nWhen creating an environmental variable key-value pair, it must follow the additional constraints\n below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.
The ID of the API to which the environmental variable list will be written.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "environmentVariables": { - "target": "com.amazonaws.appsync#EnvironmentVariableMap", - "traits": { - "smithy.api#documentation": "The list of environmental variables to add to the API.
\nWhen creating an environmental variable key-value pair, it must follow the additional constraints\n below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.
The payload containing each environmental variable in the \"key\" : \"value\" format.
The resource ARN of the RDS cluster.
", - "smithy.api#required": {} - } - }, - "secretArn": { - "target": "com.amazonaws.appsync#RdsDataApiConfigSecretArn", - "traits": { - "smithy.api#documentation": "The secret's ARN that was obtained from Secrets Manager. A secret consists of secret information, the secret\n value, plus metadata about the secret. A secret value can be a string or binary. It typically includes the ARN,\n secret name and description, policies, tags, encryption key from the Key Management Service, and key rotation\n data.
", - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.appsync#RdsDataApiConfigDatabaseName", - "traits": { - "smithy.api#documentation": "The name of the database in the cluster.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the metadata required to introspect the RDS cluster.
" - } - }, - "com.amazonaws.appsync#RdsDataApiConfigDatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.appsync#RdsDataApiConfigResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[a-z-]*:rds:[a-z0-9-]*:\\d{12}:cluster:[0-9A-Za-z_/-]*$" - } - }, - "com.amazonaws.appsync#RdsDataApiConfigSecretArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[a-z-]*:secretsmanager:[a-z0-9-]*:\\d{12}:secret:[0-9A-Za-z_/+=.@!-]*$" - } - }, - "com.amazonaws.appsync#RdsHttpEndpointConfig": { - "type": "structure", - "members": { - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Amazon Web Services Region for Amazon RDS HTTP endpoint.
" - } - }, - "dbClusterIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Amazon RDS cluster Amazon Resource Name (ARN).
" - } - }, - "databaseName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Logical database name.
" - } - }, - "schema": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Logical schema name.
" - } - }, - "awsSecretStoreArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.
" - } - }, - "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig": { - "type": "structure", - "members": { - "relationalDatabaseSourceType": { - "target": "com.amazonaws.appsync#RelationalDatabaseSourceType", - "traits": { - "smithy.api#documentation": "Source type for the relational database.
\n\n RDS_HTTP_ENDPOINT: The relational database source type is an\n Amazon Relational Database Service (Amazon RDS) HTTP endpoint.
\nAmazon RDS HTTP endpoint settings.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a relational database data source configuration.
" - } - }, - "com.amazonaws.appsync#RelationalDatabaseSourceType": { - "type": "enum", - "members": { - "RDS_HTTP_ENDPOINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS_HTTP_ENDPOINT" - } - } - } - }, - "com.amazonaws.appsync#Resolver": { - "type": "structure", - "members": { - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver type name.
" - } - }, - "fieldName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver field name.
" - } - }, - "dataSourceName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver data source name.
" - } - }, - "resolverArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The resolver Amazon Resource Name (ARN).
" - } - }, - "requestMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The request mapping template.
" - } - }, - "responseMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The response mapping template.
" - } - }, - "kind": { - "target": "com.amazonaws.appsync#ResolverKind", - "traits": { - "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" - } - }, - "maxBatchSize": { - "target": "com.amazonaws.appsync#MaxBatchSize", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Describes a resolver.
" - } - }, - "com.amazonaws.appsync#ResolverCountLimit": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 10000 - } - } - }, - "com.amazonaws.appsync#ResolverKind": { - "type": "enum", - "members": { - "UNIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNIT" - } - }, - "PIPELINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PIPELINE" - } - } - } - }, - "com.amazonaws.appsync#ResolverLevelMetricsBehavior": { - "type": "enum", - "members": { - "FULL_REQUEST_RESOLVER_METRICS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FULL_REQUEST_RESOLVER_METRICS" - } - }, - "PER_RESOLVER_METRICS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PER_RESOLVER_METRICS" - } - } - } - }, - "com.amazonaws.appsync#ResolverLevelMetricsConfig": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.appsync#Resolvers": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#Resolver" - } - }, - "com.amazonaws.appsync#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 70, - "max": 75 - }, - "smithy.api#pattern": "^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\\d{12}:apis/[0-9A-Za-z_-]{26}$" - } - }, - "com.amazonaws.appsync#ResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 65536 - }, - "smithy.api#pattern": "^[_A-Za-z][_0-9A-Za-z]*$" - } - }, - "com.amazonaws.appsync#RuntimeName": { - "type": "enum", - "members": { - "APPSYNC_JS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APPSYNC_JS" - } - } - } - }, - "com.amazonaws.appsync#SchemaStatus": { - "type": "enum", - "members": { - "Processing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROCESSING" - } - }, - "Active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "Deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Success": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "NotApplicable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_APPLICABLE" - } - } - } - }, - "com.amazonaws.appsync#SourceApiAssociation": { - "type": "structure", - "members": { - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
" - } - }, - "associationArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source API association.
" - } - }, - "sourceApiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of the AppSync source API.
" - } - }, - "sourceApiArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync source API.
" - } - }, - "mergedApiArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Merged API.
" - } - }, - "mergedApiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of the AppSync Merged API.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description field.
" - } - }, - "sourceApiAssociationConfig": { - "target": "com.amazonaws.appsync#SourceApiAssociationConfig", - "traits": { - "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The state of the source API association.
" - } - }, - "sourceApiAssociationStatusDetail": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The detailed message related to the current state of the source API association.
" - } - }, - "lastSuccessfulMergeDate": { - "target": "com.amazonaws.appsync#Date", - "traits": { - "smithy.api#documentation": "The datetime value of the last successful merge of the source API association. The result will be in UTC\n format and your local time zone.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API.\n There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's\n schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular\n API.
\nSource APIs can originate from your account or from other accounts via Amazon Web Services Resource Access\n Manager. For more information about sharing resources from other accounts, see What is Amazon Web Services Resource\n Access Manager? in the Amazon Web Services Resource Access Manager guide.
" - } - }, - "com.amazonaws.appsync#SourceApiAssociationConfig": { - "type": "structure", - "members": { - "mergeType": { - "target": "com.amazonaws.appsync#MergeType", - "traits": { - "smithy.api#documentation": "The property that indicates which merging option is enabled in the source API association.
\nValid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the\n default behavior and require the user to trigger any changes from the source APIs to the merged API manually.\n Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the\n source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform\n merge operations.
Describes properties used to specify configurations related to a source API.
" - } - }, - "com.amazonaws.appsync#SourceApiAssociationStatus": { - "type": "enum", - "members": { - "MERGE_SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MERGE_SCHEDULED" - } - }, - "MERGE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MERGE_FAILED" - } - }, - "MERGE_SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MERGE_SUCCESS" - } - }, - "MERGE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MERGE_IN_PROGRESS" - } - }, - "AUTO_MERGE_SCHEDULE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO_MERGE_SCHEDULE_FAILED" - } - }, - "DELETION_SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_SCHEDULED" - } - }, - "DELETION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_IN_PROGRESS" - } - }, - "DELETION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_FAILED" - } - } - } - }, - "com.amazonaws.appsync#SourceApiAssociationSummary": { - "type": "structure", - "members": { - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
" - } - }, - "associationArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source API association.
" - } - }, - "sourceApiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of the AppSync source API.
" - } - }, - "sourceApiArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Source API.
" - } - }, - "mergedApiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of the AppSync Merged API.
" - } - }, - "mergedApiArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Merged API.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description field.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the ARNs and IDs of associations, Merged APIs, and source APIs.
" - } - }, - "com.amazonaws.appsync#SourceApiAssociationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#SourceApiAssociationSummary" - } - }, - "com.amazonaws.appsync#StartDataSourceIntrospection": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#StartDataSourceIntrospectionRequest" - }, - "output": { - "target": "com.amazonaws.appsync#StartDataSourceIntrospectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new introspection. Returns the introspectionId of the new introspection after its\n creation.
The rdsDataApiConfig object data.
The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
" - } - }, - "introspectionStatus": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionStatus", - "traits": { - "smithy.api#documentation": "The status of the introspection during creation. By default, when a new instrospection has been created, the\n status will be set to PROCESSING. Once the operation has been completed, the status will change to\n SUCCESS or FAILED depending on how the data was parsed. A FAILED\n operation will return an error and its details as an introspectionStatusDetail.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail will also return the\n exact error that was generated during the operation.
Adds a new schema to your GraphQL API.
\nThis operation is asynchronous. Use to determine when it has\n completed.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/schemacreation", - "code": 200 - } - } - }, - "com.amazonaws.appsync#StartSchemaCreationRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.appsync#Blob", - "traits": { - "smithy.api#documentation": "The schema definition, in GraphQL schema language format.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#StartSchemaCreationResponse": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.appsync#SchemaStatus", - "traits": { - "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the\n ACTIVE state, you can add data.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#StartSchemaMerge": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#StartSchemaMergeRequest" - }, - "output": { - "target": "com.amazonaws.appsync#StartSchemaMergeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Initiates a merge operation. Returns a status that shows the result of the merge operation.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}/merge", - "code": 200 - } - } - }, - "com.amazonaws.appsync#StartSchemaMergeRequest": { - "type": "structure", - "members": { - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "mergedApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#StartSchemaMergeResponse": { - "type": "structure", - "members": { - "sourceApiAssociationStatus": { - "target": "com.amazonaws.appsync#SourceApiAssociationStatus", - "traits": { - "smithy.api#documentation": "The state of the source API association.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#String": { - "type": "string" - }, - "com.amazonaws.appsync#SyncConfig": { - "type": "structure", - "members": { - "conflictHandler": { - "target": "com.amazonaws.appsync#ConflictHandlerType", - "traits": { - "smithy.api#documentation": "The Conflict Resolution strategy to perform in the event of a conflict.
\n\n OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations\n when versions don't match the latest version at the server.
\n\n AUTOMERGE: Resolve conflicts with the Automerge conflict\n resolution strategy.
\n\n LAMBDA: Resolve conflicts with an Lambda function\n supplied in the LambdaConflictHandlerConfig.
The Conflict Detection strategy to use.
\n\n VERSION: Detect conflicts based on object versions for this\n resolver.
\n\n NONE: Do not detect conflicts when invoking this\n resolver.
\nThe LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict\n Handler.
Describes a Sync configuration for a resolver.
\nSpecifies which Conflict Detection strategy and Resolution strategy to use when the resolver is\n invoked.
" - } - }, - "com.amazonaws.appsync#TTL": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 3600 - } - } - }, - "com.amazonaws.appsync#TagKey": { - "type": "string", - "traits": { - "smithy.api#documentation": "The key for the tag.
", - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[ a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.appsync#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.appsync#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.appsync#TagKey" - }, - "value": { - "target": "com.amazonaws.appsync#TagValue" - }, - "traits": { - "smithy.api#documentation": "A map with keys of TagKey objects and values of TagValue objects.
Tags a resource with user-supplied tags.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.appsync#ResourceArn", - "traits": { - "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A TagMap object.
The value for the tag.
", - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[\\s\\w+-=\\.:/@]*$" - } - }, - "com.amazonaws.appsync#Template": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 65536 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.appsync#Type": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The type name.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type description.
" - } - }, - "arn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type Amazon Resource Name (ARN).
" - } - }, - "definition": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type definition.
" - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The type format: SDL or JSON.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a type.
" - } - }, - "com.amazonaws.appsync#TypeDefinitionFormat": { - "type": "enum", - "members": { - "SDL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SDL" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - } - } - }, - "com.amazonaws.appsync#TypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#Type" - } - }, - "com.amazonaws.appsync#UnauthorizedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" - } - }, - "traits": { - "smithy.api#documentation": "You aren't authorized to perform this operation.
", - "smithy.api#error": "client", - "smithy.api#httpError": 401 - } - }, - "com.amazonaws.appsync#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.appsync#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#LimitExceededException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Untags a resource.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/v1/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.appsync#ResourceArn", - "traits": { - "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A list of TagKey objects.
Updates the cache for the GraphQL API.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/ApiCaches/update", - "code": 200 - } - } - }, - "com.amazonaws.appsync#UpdateApiCacheRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ttl": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
", - "smithy.api#required": {} - } - }, - "apiCachingBehavior": { - "target": "com.amazonaws.appsync#ApiCachingBehavior", - "traits": { - "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nThe cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
Represents the input of a UpdateApiCache operation.
The ApiCache object.
Represents the output of a UpdateApiCache operation.
Updates an API key. You can update the key as long as it's not deleted.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/apikeys/{id}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#UpdateApiKeyRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID for the GraphQL API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API key ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "A description of the purpose of the API key.
" - } - }, - "expires": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "From the update time, the time after which the API key expires. The date is represented as seconds since the\n epoch. For more information, see .
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#UpdateApiKeyResponse": { - "type": "structure", - "members": { - "apiKey": { - "target": "com.amazonaws.appsync#ApiKey", - "traits": { - "smithy.api#documentation": "The API key.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#UpdateDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#UpdateDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.appsync#UpdateDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Updates a DataSource object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The new name for the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The new description for the data source.
" - } - }, - "type": { - "target": "com.amazonaws.appsync#DataSourceType", - "traits": { - "smithy.api#documentation": "The new data source type.
", - "smithy.api#required": {} - } - }, - "serviceRoleArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The new service role Amazon Resource Name (ARN) for the data source.
" - } - }, - "dynamodbConfig": { - "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new Amazon DynamoDB configuration.
" - } - }, - "lambdaConfig": { - "target": "com.amazonaws.appsync#LambdaDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new Lambda configuration.
" - } - }, - "elasticsearchConfig": { - "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new OpenSearch configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.
" - } - }, - "openSearchServiceConfig": { - "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new OpenSearch configuration.
" - } - }, - "httpConfig": { - "target": "com.amazonaws.appsync#HttpDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new HTTP endpoint configuration.
" - } - }, - "relationalDatabaseConfig": { - "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new relational database configuration.
" - } - }, - "eventBridgeConfig": { - "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new Amazon EventBridge settings.
" - } - }, - "metricsConfig": { - "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", - "traits": { - "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The updated DataSource object.
Updates a custom DomainName object.
The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#Description", - "traits": { - "smithy.api#documentation": "A description of the DomainName.
The configuration for the DomainName.
Updates a Function object.
The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The Function name.
The Function description.
The function ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The Function\n DataSource name.
The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function request mapping template.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note\n that when using VTL and mapping templates, the functionVersion is required.
The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The Function object.
Updates a GraphqlApi object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The new name for the GraphqlApi object.
The Amazon CloudWatch Logs configuration for the GraphqlApi object.
The new authentication type for the GraphqlApi object.
The new Amazon Cognito user pool configuration for the ~GraphqlApi object.
The OpenID Connect configuration for the GraphqlApi object.
A list of additional authentication providers for the GraphqlApi API.
A flag indicating whether to use X-Ray tracing for the GraphqlApi.
Configuration for Lambda function authorization.
" - } - }, - "mergedApiExecutionRoleArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" - } - }, - "introspectionConfig": { - "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", - "traits": { - "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" - } - }, - "queryDepthLimit": { - "target": "com.amazonaws.appsync#QueryDepthLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" - } - }, - "resolverCountLimit": { - "target": "com.amazonaws.appsync#ResolverCountLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The enhancedMetricsConfig object.
The updated GraphqlApi object.
Updates a Resolver object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The new type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "fieldName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The new field name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The new data source name.
" - } - }, - "requestMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The new request mapping template.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format that a data source\n can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data source. For all other\n data sources, VTL request and response mapping templates are required.
" - } - }, - "responseMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The new response mapping template.
" - } - }, - "kind": { - "target": "com.amazonaws.appsync#ResolverKind", - "traits": { - "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" - } - }, - "maxBatchSize": { - "target": "com.amazonaws.appsync#MaxBatchSize", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The updated Resolver object.
Updates some of the configuration choices of a particular source API association.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#UpdateSourceApiAssociationRequest": { - "type": "structure", - "members": { - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "mergedApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description field.
" - } - }, - "sourceApiAssociationConfig": { - "target": "com.amazonaws.appsync#SourceApiAssociationConfig", - "traits": { - "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
Updates a Type object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The new type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The new definition.
" - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The new type format: SDL or JSON.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#UpdateTypeResponse": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.appsync#Type", - "traits": { - "smithy.api#documentation": "The updated Type object.
The user pool ID.
", - "smithy.api#required": {} - } - }, - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Region in which the user pool was created.
", - "smithy.api#required": {} - } - }, - "defaultAction": { - "target": "com.amazonaws.appsync#DefaultAction", - "traits": { - "smithy.api#documentation": "The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool\n authentication doesn't match the Amazon Cognito user pool configuration.
", - "smithy.api#required": {} - } - }, - "appIdClientRegex": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value\n isn't set, no filtering is applied.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" - } + "detail": { + "target": "com.amazonaws.appsync#BadRequestDetail" + } + }, + "traits": { + "smithy.api#documentation": "The request is not well formed. For example, a value is invalid or a required field is\n missing. Check the field values, and then try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appsync#BadRequestReason": { + "type": "enum", + "members": { + "CODE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODE_ERROR" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides context for the cause of the bad request. The only supported value is\n CODE_ERROR.
The TTL in seconds for a resolver that has caching activated.
\nValid values are 1–3,600 seconds.
", + "smithy.api#required": {} + } + }, + "cachingKeys": { + "target": "com.amazonaws.appsync#CachingKeys", + "traits": { + "smithy.api#documentation": "The caching keys for a resolver that has caching activated.
\nValid values are entries from the $context.arguments,\n $context.source, and $context.identity maps.
The caching configuration for a resolver that has caching activated.
" + } + }, + "com.amazonaws.appsync#CachingKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#String" + } + }, + "com.amazonaws.appsync#CertificateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z-]*:(acm|iam):[a-z0-9-]*:\\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$" + } + }, + "com.amazonaws.appsync#ChannelNamespace": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Api ID.
The name of the channel namespace. This name must be unique within the\n Api.
The authorization mode to use for subscribing to messages on the channel namespace. This\n configuration overrides the default Apiauthorization configuration.
The authorization mode to use for publishing messages on the channel namespace. This\n configuration overrides the default Apiauthorization configuration.
The event handler functions that run custom business logic to process published events\n and subscribe requests.
" + } + }, + "tags": { + "target": "com.amazonaws.appsync#TagMap" + }, + "channelNamespaceArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the ChannelNamespace.
The date and time that the ChannelNamespace was created.
The date and time that the ChannelNamespace was last changed.
Describes a channel namespace associated with an Api. The ChannelNamespace contains the definitions for code handlers for the Api.
The type of code error.
\nExamples include, but aren't limited to: LINT_ERROR,\n PARSER_ERROR.
A user presentable error.
\nExamples include, but aren't limited to: Parsing error: Unterminated string\n literal.
The line, column, and span location of the error in the code.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an AppSync error.
" + } + }, + "com.amazonaws.appsync#CodeErrorColumn": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.appsync#CodeErrorLine": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.appsync#CodeErrorLocation": { + "type": "structure", + "members": { + "line": { + "target": "com.amazonaws.appsync#CodeErrorLine", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The line number in the code. Defaults to 0 if unknown.
The column number in the code. Defaults to 0 if unknown.
The span/length of the error. Defaults to -1 if unknown.
Describes the location of the error in a code sample.
" + } + }, + "com.amazonaws.appsync#CodeErrorSpan": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.appsync#CodeErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#CodeError" + } + }, + "com.amazonaws.appsync#CognitoConfig": { + "type": "structure", + "members": { + "userPoolId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The user pool ID.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region in which the user pool was created.
", + "smithy.api#required": {} + } + }, + "appIdClientRegex": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client\n ID. If this value isn't set, no filtering is applied.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Amazon Cognito configuration.
" + } + }, + "com.amazonaws.appsync#CognitoUserPoolConfig": { + "type": "structure", + "members": { + "userPoolId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The user pool ID.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region in which the user pool was created.
", + "smithy.api#required": {} + } + }, + "appIdClientRegex": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client\n ID. If this value isn't set, no filtering is applied.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" + } + }, + "com.amazonaws.appsync#ConcurrentModificationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "Another modification is in progress at this time and it must complete before you can\n make your change.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.appsync#ConflictDetectionType": { + "type": "enum", + "members": { + "VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSION" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.appsync#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "A conflict with a previous successful update is detected. This typically\n occurs when the previous update did not have time to propagate before the next update was\n made. A retry (with appropriate backoff logic) is the recommended response to this\n exception.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.appsync#ConflictHandlerType": { + "type": "enum", + "members": { + "OPTIMISTIC_CONCURRENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPTIMISTIC_CONCURRENCY" + } + }, + "LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA" + } + }, + "AUTOMERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMERGE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.appsync#Context": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 28000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.appsync#CreateApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#CreateApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#CreateApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Api object. Use this operation to create an AppSync\n API with your preferred configuration, such as an Event API that provides real-time message\n publishing and message subscriptions over WebSockets.
Creates a cache for the GraphQL API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/ApiCaches", + "code": 200 + } + } + }, + "com.amazonaws.appsync#CreateApiCacheRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ttl": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
", + "smithy.api#required": {} + } + }, + "transitEncryptionEnabled": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Transit encryption flag when connecting to cache. You cannot update this setting after\n creation.
" + } + }, + "atRestEncryptionEnabled": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "At-rest encryption flag for cache. You cannot update this setting after creation.
" + } + }, + "apiCachingBehavior": { + "target": "com.amazonaws.appsync#ApiCachingBehavior", + "traits": { + "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully\n cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers\n that you specify are cached.
\nThe cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics\n include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the\n throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing\n bottlenecks in a cache configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis\n process. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
Represents the input of a CreateApiCache operation.
The ApiCache object.
Represents the output of a CreateApiCache operation.
Creates a unique key that you can distribute to clients who invoke your API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/apikeys", + "code": 200 + } + } + }, + "com.amazonaws.appsync#CreateApiKeyRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID for your GraphQL API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A description of the purpose of the API key.
" + } + }, + "expires": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "From the creation time, the time after which the API key expires. The date is\n represented as seconds since the epoch, rounded down to the nearest hour. The default value\n for this parameter is 7 days from creation time. For more information, see .
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#CreateApiKeyResponse": { + "type": "structure", + "members": { + "apiKey": { + "target": "com.amazonaws.appsync#ApiKey", + "traits": { + "smithy.api#documentation": "The API key.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#CreateApiRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#ApiName", + "traits": { + "smithy.api#documentation": "The name for the Api.
The owner contact information for the Api.
The Event API configuration. This includes the default authorization configuration for\n connecting, publishing, and subscribing to an Event API.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#CreateApiResponse": { + "type": "structure", + "members": { + "api": { + "target": "com.amazonaws.appsync#Api", + "traits": { + "smithy.api#documentation": "The Api object.
Creates a ChannelNamespace for an Api.
The Api ID.
The name of the ChannelNamespace. This name must be unique within the\n Api\n
The authorization mode to use for subscribing to messages on the channel namespace. This\n configuration overrides the default Api authorization configuration.
The authorization mode to use for publishing messages on the channel namespace. This\n configuration overrides the default Api authorization configuration.
The event handler functions that run custom business logic to process published events\n and subscribe requests.
" + } + }, + "tags": { + "target": "com.amazonaws.appsync#TagMap" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#CreateChannelNamespaceResponse": { + "type": "structure", + "members": { + "channelNamespace": { + "target": "com.amazonaws.appsync#ChannelNamespace", + "traits": { + "smithy.api#documentation": "The ChannelNamespace object.
Creates a DataSource object.
The API ID for the GraphQL API for the DataSource.
A user-supplied name for the DataSource.
A description of the DataSource.
The type of the DataSource.
The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)\n for the data source. The system assumes this role when accessing the data source.
" + } + }, + "dynamodbConfig": { + "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon DynamoDB settings.
" + } + }, + "lambdaConfig": { + "target": "com.amazonaws.appsync#LambdaDataSourceConfig", + "traits": { + "smithy.api#documentation": "Lambda settings.
" + } + }, + "elasticsearchConfig": { + "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon OpenSearch Service settings.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This\n configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.
" + } + }, + "openSearchServiceConfig": { + "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon OpenSearch Service settings.
" + } + }, + "httpConfig": { + "target": "com.amazonaws.appsync#HttpDataSourceConfig", + "traits": { + "smithy.api#documentation": "HTTP endpoint settings.
" + } + }, + "relationalDatabaseConfig": { + "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", + "traits": { + "smithy.api#documentation": "Relational database settings.
" + } + }, + "eventBridgeConfig": { + "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon EventBridge settings.
" + } + }, + "metricsConfig": { + "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", + "traits": { + "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the\n dataSourceLevelMetricsBehavior value is set to\n PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior\n is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig\n will be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The DataSource object.
Creates a custom DomainName object.
The domain name.
", + "smithy.api#required": {} + } + }, + "certificateArn": { + "target": "com.amazonaws.appsync#CertificateArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager\n (ACM) certificate or an Identity and Access Management (IAM)\n server certificate.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#Description", + "traits": { + "smithy.api#documentation": "A description of the DomainName.
The configuration for the DomainName.
Creates a Function object.
A function is a reusable entity. You can use multiple functions to compose the resolver\n logic.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/functions", + "code": 200 + } + } + }, + "com.amazonaws.appsync#CreateFunctionRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The Function name. The function name does not have to be unique.
The Function description.
The Function\n DataSource name.
The Function request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.
The Function response mapping template.
The version of the request mapping template. Currently, the supported value\n is 2018-05-29. Note that when using VTL and mapping templates, the\n functionVersion is required.
The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The function code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
The Function object.
Creates a GraphqlApi object.
A user-supplied name for the GraphqlApi.
The Amazon CloudWatch Logs configuration.
" + } + }, + "authenticationType": { + "target": "com.amazonaws.appsync#AuthenticationType", + "traits": { + "smithy.api#documentation": "The authentication type: API key, Identity and Access Management (IAM), OpenID\n Connect (OIDC), Amazon Cognito user pools, or Lambda.
", + "smithy.api#required": {} + } + }, + "userPoolConfig": { + "target": "com.amazonaws.appsync#UserPoolConfig", + "traits": { + "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" + } + }, + "openIDConnectConfig": { + "target": "com.amazonaws.appsync#OpenIDConnectConfig", + "traits": { + "smithy.api#documentation": "The OIDC configuration.
" + } + }, + "tags": { + "target": "com.amazonaws.appsync#TagMap", + "traits": { + "smithy.api#documentation": "A TagMap object.
A list of additional authentication providers for the GraphqlApi\n API.
A flag indicating whether to use X-Ray tracing for the\n GraphqlApi.
Configuration for Lambda function authorization.
" + } + }, + "apiType": { + "target": "com.amazonaws.appsync#GraphQLApiType", + "traits": { + "smithy.api#documentation": "The value that indicates whether the GraphQL API is a standard API\n (GRAPHQL) or merged API (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync\n service assumes this role on behalf of the Merged API to validate access to source APIs at\n runtime and to prompt the AUTO_MERGE to update the merged API endpoint with\n the source API changes automatically.
Sets the value of the GraphQL API to public (GLOBAL) or private\n (PRIVATE). If no value is provided, the visibility will be set to\n GLOBAL by default. This value cannot be changed once the API has been\n created.
The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" + } + }, + "introspectionConfig": { + "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", + "traits": { + "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable\n (DISABLED) introspection. If no value is provided, the introspection\n configuration will be set to ENABLED by default. This field will produce an\n error if the operation attempts to use the introspection feature while this field is\n disabled.
For more information about introspection, see GraphQL introspection.
" + } + }, + "queryDepthLimit": { + "target": "com.amazonaws.appsync#QueryDepthLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of\n nested levels allowed in the body of query. The default value is 0 (or\n unspecified), which indicates there's no depth limit. If you set a limit, it can be between\n 1 and 75 nested levels. This field will produce a limit error\n if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field\n produces an error, the error will be thrown upwards to the first nullable field\n available.
" + } + }, + "resolverCountLimit": { + "target": "com.amazonaws.appsync#ResolverCountLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default\n value is 0 (or unspecified), which will set the limit to 10000.\n When specified, the limit value can be between 1 and 10000. This\n field will produce a limit error if the operation falls out of bounds.
The enhancedMetricsConfig object.
The GraphqlApi.
Creates a Resolver object.
A resolver converts incoming requests into a format that a data source can understand,\n and converts the data source's responses into GraphQL.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", + "code": 200 + } + } + }, + "com.amazonaws.appsync#CreateResolverRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID for the GraphQL API for which the resolver is being created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the Type.
The name of the field to attach the resolver to.
", + "smithy.api#required": {} + } + }, + "dataSourceName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the data source for which the resolver is being created.
" + } + }, + "requestMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The mapping template to use for requests.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data\n source. For all other data sources, VTL request and response mapping templates are\n required.
" + } + }, + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The mapping template to use for responses from the data source.
" + } + }, + "kind": { + "target": "com.amazonaws.appsync#ResolverKind", + "traits": { + "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. You can use a UNIT resolver to run a GraphQL query against\n a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can\n use a PIPELINE resolver to invoke a series of Function objects in a\n serial manner. You can use a pipeline resolver to run a GraphQL query against\n multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" + } + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The resolver code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that\n metricsConfig won't be used unless the\n resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is\n set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will\n be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The Resolver object.
Creates a Type object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The type definition, in GraphQL Schema Definition Language (SDL) format.
\nFor more information, see the GraphQL SDL\n documentation.
", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The type format: SDL or JSON.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#CreateTypeResponse": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.appsync#Type", + "traits": { + "smithy.api#documentation": "The Type object.
The data source Amazon Resource Name (ARN).
" + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description of the data source.
" + } + }, + "type": { + "target": "com.amazonaws.appsync#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of the data source.
\n\n AWS_LAMBDA: The data source is an Lambda function.
\n\n AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
\n\n AMAZON_ELASTICSEARCH: The data source is an\n Amazon OpenSearch Service domain.
\n\n AMAZON_OPENSEARCH_SERVICE: The data source is\n an Amazon OpenSearch Service domain.
\n\n AMAZON_EVENTBRIDGE: The data source is an\n Amazon EventBridge configuration.
\n\n NONE: There is no data source. Use this type\n when you want to invoke a GraphQL operation without connecting to a data source, such\n as when you're performing data transformation with resolvers or invoking a\n subscription from a mutation.
\n\n HTTP: The data source is an HTTP\n endpoint.
\n\n RELATIONAL_DATABASE: The data source is a\n relational database.
\nThe Identity and Access Management (IAM) service role Amazon Resource Name (ARN)\n for the data source. The system assumes this role when accessing the data source.
" + } + }, + "dynamodbConfig": { + "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", + "traits": { + "smithy.api#documentation": "DynamoDB settings.
" + } + }, + "lambdaConfig": { + "target": "com.amazonaws.appsync#LambdaDataSourceConfig", + "traits": { + "smithy.api#documentation": "Lambda settings.
" + } + }, + "elasticsearchConfig": { + "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon OpenSearch Service settings.
" + } + }, + "openSearchServiceConfig": { + "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon OpenSearch Service settings.
" + } + }, + "httpConfig": { + "target": "com.amazonaws.appsync#HttpDataSourceConfig", + "traits": { + "smithy.api#documentation": "HTTP endpoint settings.
" + } + }, + "relationalDatabaseConfig": { + "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", + "traits": { + "smithy.api#documentation": "Relational database settings.
" + } + }, + "eventBridgeConfig": { + "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon EventBridge settings.
" + } + }, + "metricsConfig": { + "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", + "traits": { + "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the\n dataSourceLevelMetricsBehavior value is set to\n PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior\n is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig\n will be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Describes a data source.
" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModel": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The name of the model. For example, this could be the name of a single table in a\n database.
" + } + }, + "fields": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelFields", + "traits": { + "smithy.api#documentation": "The DataSourceIntrospectionModelField object data.
The primary key stored as a DataSourceIntrospectionModelIndex\n object.
The array of DataSourceIntrospectionModelIndex objects.
Contains the output of the SDL that was generated from the introspected types. This is\n controlled by the includeModelsSDL parameter of the\n GetDataSourceIntrospection operation.
Contains the introspected data that was retrieved from the data source.
" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The name of the field that was retrieved from the introspected data.
" + } + }, + "type": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelFieldType", + "traits": { + "smithy.api#documentation": "The DataSourceIntrospectionModelFieldType object data.
The length value of the introspected field.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the fields that were retrieved from the introspected data.
" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelFieldType": { + "type": "structure", + "members": { + "kind": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Specifies the classification of data. For example, this could be set to values like\n Scalar or NonNull to indicate a fundamental property of the\n field.
Valid values include:
\n\n Scalar: Indicates the value is a primitive type\n (scalar).
\n NonNull: Indicates the field cannot be\n null.
\n List: Indicates the field contains a list.
The name of the data type that represents the field. For example, String is\n a valid name value.
The DataSourceIntrospectionModelFieldType object data. The\n type is only present if\n DataSourceIntrospectionModelFieldType.kind is set to NonNull\n or List.
The type typically contains its own kind and name\n fields to represent the actual type data. For instance, type could contain a\n kind value of Scalar with a name value of\n String. The values Scalar and String will be\n collectively stored in the values field.
The values of the type field. This field represents the AppSync data type\n equivalent of the introspected field.
Represents the type data for each field retrieved from the introspection.
" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelFieldTypeValues": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#String" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelFields": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelField" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelIndex": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The name of the index.
" + } + }, + "fields": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelIndexFields", + "traits": { + "smithy.api#documentation": "The fields of the index.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The index that was retrieved from the introspected data.
" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelIndexFields": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#String" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelIndexes": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelIndex" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModels": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModel" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionResult": { + "type": "structure", + "members": { + "models": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModels", + "traits": { + "smithy.api#documentation": "The array of DataSourceIntrospectionModel objects.
Determines the number of types to be returned in a single response before paginating.\n This value is typically taken from nextToken value from the previous\n response.
Represents the output of a DataSourceIntrospectionResult. This is the\n populated result of a GetDataSourceIntrospection operation.
Deletes an Api object
Deletes an ApiCache object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input of a DeleteApiCache operation.
Represents the output of a DeleteApiCache operation.
Deletes an API key.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/apis/{apiId}/apikeys/{id}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#DeleteApiKeyRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID for the API key.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteApiKeyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeleteApiRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Api ID.
Deletes a ChannelNamespace.
The ID of the Api associated with the ChannelNamespace.
The name of the ChannelNamespace.
Deletes a DataSource object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteDataSourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeleteDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DeleteDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DeleteDomainNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a custom DomainName object.
The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteDomainNameResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeleteFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DeleteFunctionRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DeleteFunctionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Function.
The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "functionId": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The Function ID.
Deletes a GraphqlApi object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteGraphqlApiResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeleteResolver": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DeleteResolverRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DeleteResolverResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Resolver object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the resolver type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fieldName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver field name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteResolverResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeleteType": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DeleteTypeRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DeleteTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Type object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteTypeResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeltaSyncConfig": { + "type": "structure", + "members": { + "baseTableTTL": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of minutes that an Item is stored in the data source.
" + } + }, + "deltaSyncTableName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Delta Sync table name.
" + } + }, + "deltaSyncTableTTL": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of minutes that a Delta Sync log entry is stored in the Delta Sync\n table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a Delta Sync configuration.
" + } + }, + "com.amazonaws.appsync#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.appsync#DisassociateApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DisassociateApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DisassociateApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Removes an ApiAssociation object from a custom domain.
The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DisassociateApiResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DisassociateMergedGraphqlApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DisassociateMergedGraphqlApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DisassociateMergedGraphqlApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an association between a Merged API and source API using the source API's\n identifier and the association ID.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations/{associationId}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#DisassociateMergedGraphqlApiRequest": { + "type": "structure", + "members": { + "sourceApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In\n most cases, source APIs (especially in your account) only require the API ID value or ARN\n of the source API. However, source APIs from other accounts (cross-account use cases)\n strictly require the full resource ARN of the source API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DisassociateMergedGraphqlApiResponse": { + "type": "structure", + "members": { + "sourceApiAssociationStatus": { + "target": "com.amazonaws.appsync#SourceApiAssociationStatus", + "traits": { + "smithy.api#documentation": "The state of the source API association.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DisassociateSourceGraphqlApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DisassociateSourceGraphqlApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DisassociateSourceGraphqlApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an association between a Merged API and source API using the Merged API's\n identifier and the association ID.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#DisassociateSourceGraphqlApiRequest": { + "type": "structure", + "members": { + "mergedApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DisassociateSourceGraphqlApiResponse": { + "type": "structure", + "members": { + "sourceApiAssociationStatus": { + "target": "com.amazonaws.appsync#SourceApiAssociationStatus", + "traits": { + "smithy.api#documentation": "The state of the source API association.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": "^(\\*[\\w\\d-]*\\.)?([\\w\\d-]+\\.)+[\\w\\d-]+$" + } + }, + "com.amazonaws.appsync#DomainNameConfig": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "The domain name.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#Description", + "traits": { + "smithy.api#documentation": "A description of the DomainName configuration.
The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager\n (ACM) certificate or an Identity and Access Management (IAM)\n server certificate.
" + } + }, + "appsyncDomainName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The domain name that AppSync provides.
" + } + }, + "hostedZoneId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of your Amazon Route 53 hosted zone.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a configuration for a custom domain.
" + } + }, + "com.amazonaws.appsync#DomainNameConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#DomainNameConfig" + } + }, + "com.amazonaws.appsync#DynamodbDataSourceConfig": { + "type": "structure", + "members": { + "tableName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The table name.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region.
", + "smithy.api#required": {} + } + }, + "useCallerCredentials": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Set to TRUE to use Amazon Cognito credentials with this data source.
" + } + }, + "deltaSyncConfig": { + "target": "com.amazonaws.appsync#DeltaSyncConfig", + "traits": { + "smithy.api#documentation": "The DeltaSyncConfig for a versioned data source.
Set to TRUE to use Conflict Detection and Resolution with this data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Amazon DynamoDB data source configuration.
" + } + }, + "com.amazonaws.appsync#ElasticsearchDataSourceConfig": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The endpoint.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an OpenSearch data source configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This\n configuration is deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data\n source.
" + } + }, + "com.amazonaws.appsync#EnhancedMetricsConfig": { + "type": "structure", + "members": { + "resolverLevelMetricsBehavior": { + "target": "com.amazonaws.appsync#ResolverLevelMetricsBehavior", + "traits": { + "smithy.api#documentation": "Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics\n include:
\nGraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the\n request. Metrics will be recorded by API ID and resolver name.\n resolverLevelMetricsBehavior accepts one of these values at a time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for\n all resolvers in the request.
\n PER_RESOLVER_METRICS: Records and emits metric data for resolvers\n that have the metricsConfig value set to ENABLED.
Controls how data source metrics will be emitted to CloudWatch. Data source metrics\n include:
\nRequests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source\n invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in\n the request. Metrics will be recorded by API ID and data source name.\n dataSourceLevelMetricsBehavior accepts one of these values at a\n time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data\n for all data sources in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for data\n sources that have the metricsConfig value set to\n ENABLED.
Controls how operation metrics will be emitted to CloudWatch. Operation metrics\n include:
\nRequests: The number of times a specified GraphQL operation was\n called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified\n GraphQL operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to\n ENABLED or DISABLED.
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data\n on API usage and performance such as AppSync request and error counts, latency, and cache\n hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can\n configure the types of data that will be sent.
\nEnhanced metrics can be configured at the resolver, data source, and operation levels.\n EnhancedMetricsConfig contains three required parameters, each controlling\n one of these categories:
\n resolverLevelMetricsBehavior: Controls how resolver metrics will\n be emitted to CloudWatch. Resolver metrics include:
GraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.\n
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in\n the request. Metrics will be recorded by API ID and resolver name.\n resolverLevelMetricsBehavior accepts one of these values at a\n time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data\n for all resolvers in the request.
\n PER_RESOLVER_METRICS: Records and emits metric data for\n resolvers that have the metricsConfig value set to\n ENABLED.
\n dataSourceLevelMetricsBehavior: Controls how data source metrics\n will be emitted to CloudWatch. Data source metrics include:
Requests: The number of invocations that occured during a\n request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source\n invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources\n in the request. Metrics will be recorded by API ID and data source name.\n dataSourceLevelMetricsBehavior accepts one of these values at a\n time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric\n data for all data sources in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for\n data sources that have the metricsConfig value set to\n ENABLED.
\n operationLevelMetricsConfig: Controls how operation metrics will\n be emitted to CloudWatch. Operation metrics include:
Requests: The number of times a specified GraphQL operation was\n called.
\nGraphQL errors: The number of GraphQL errors that occurred during a\n specified GraphQL operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to\n ENABLED or DISABLED.
The error payload.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the list of errors generated. When using JavaScript, this will apply to the\n request or response function evaluation.
" + } + }, + "com.amazonaws.appsync#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.appsync#EvaluateCode": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#EvaluateCodeRequest" + }, + "output": { + "target": "com.amazonaws.appsync#EvaluateCodeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + } + ], + "traits": { + "smithy.api#documentation": "Evaluates the given code and returns the response. The code definition requirements\n depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the\n request and response functions. The request function takes the incoming request after a\n GraphQL operation is parsed and converts it into a request configuration for the selected\n data source operation. The response function interprets responses from the data source and\n maps it to the shape of the GraphQL field output type.
The error payload.
" + } + }, + "codeErrors": { + "target": "com.amazonaws.appsync#CodeErrors", + "traits": { + "smithy.api#documentation": "Contains the list of CodeError objects.
Contains the list of errors from a code evaluation response.
" + } + }, + "com.amazonaws.appsync#EvaluateCodeRequest": { + "type": "structure", + "members": { + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime", + "traits": { + "smithy.api#documentation": "The runtime to be used when evaluating the code. Currently, only the\n APPSYNC_JS runtime is supported.
The code definition to be evaluated. Note that code and\n runtime are both required for this action. The runtime value\n must be APPSYNC_JS.
The map that holds all of the contextual information for your resolver invocation. A\n context is required for this action.
The function within the code to be evaluated. If provided, the valid values are\n request and response.
The result of the evaluation operation.
" + } + }, + "error": { + "target": "com.amazonaws.appsync#EvaluateCodeErrorDetail", + "traits": { + "smithy.api#documentation": "Contains the payload of the response error.
" + } + }, + "logs": { + "target": "com.amazonaws.appsync#Logs", + "traits": { + "smithy.api#documentation": "A list of logs that were generated by calls to util.log.info and\n util.log.error in the evaluated code.
Evaluates a given template and returns the response. The mapping template can be a\n request or response template.
\nRequest templates take the incoming request after a GraphQL operation is parsed and\n convert it into a request configuration for the selected data source operation. Response\n templates interpret responses from the data source and map it to the shape of the GraphQL\n field output type.
\nMapping templates are written in the Apache Velocity Template Language (VTL).
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/dataplane-evaluatetemplate", + "code": 200 + } + } + }, + "com.amazonaws.appsync#EvaluateMappingTemplateRequest": { + "type": "structure", + "members": { + "template": { + "target": "com.amazonaws.appsync#Template", + "traits": { + "smithy.api#documentation": "The mapping template; this can be a request or response template. A\n template is required for this action.
The map that holds all of the contextual information for your resolver invocation. A\n context is required for this action.
The mapping template; this can be a request or response template.
" + } + }, + "error": { + "target": "com.amazonaws.appsync#ErrorDetail", + "traits": { + "smithy.api#documentation": "The ErrorDetail object.
A list of logs that were generated by calls to util.log.info and\n util.log.error in the evaluated code.
The ARN of the event bus. For more information about event buses, see Amazon\n EventBridge event buses.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Amazon EventBridge bus data source configuration.
" + } + }, + "com.amazonaws.appsync#EventConfig": { + "type": "structure", + "members": { + "authProviders": { + "target": "com.amazonaws.appsync#AuthProviders", + "traits": { + "smithy.api#documentation": "A list of authorization providers.
", + "smithy.api#required": {} + } + }, + "connectionAuthModes": { + "target": "com.amazonaws.appsync#AuthModes", + "traits": { + "smithy.api#documentation": "A list of valid authorization modes for the Event API connections.
", + "smithy.api#required": {} + } + }, + "defaultPublishAuthModes": { + "target": "com.amazonaws.appsync#AuthModes", + "traits": { + "smithy.api#documentation": "A list of valid authorization modes for the Event API publishing.
", + "smithy.api#required": {} + } + }, + "defaultSubscribeAuthModes": { + "target": "com.amazonaws.appsync#AuthModes", + "traits": { + "smithy.api#documentation": "A list of valid authorization modes for the Event API subscriptions.
", + "smithy.api#required": {} + } + }, + "logConfig": { + "target": "com.amazonaws.appsync#EventLogConfig", + "traits": { + "smithy.api#documentation": "The CloudWatch Logs configuration for the Event API.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the authorization configuration for connections, message publishing, message\n subscriptions, and logging for an Event API.
" + } + }, + "com.amazonaws.appsync#EventLogConfig": { + "type": "structure", + "members": { + "logLevel": { + "target": "com.amazonaws.appsync#EventLogLevel", + "traits": { + "smithy.api#documentation": "The type of information to log for the Event API.
", + "smithy.api#required": {} + } + }, + "cloudWatchLogsRoleArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The IAM service role that AppSync assumes to publish CloudWatch Logs in your account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the CloudWatch Logs configuration for the Event API.
" + } + }, + "com.amazonaws.appsync#EventLogLevel": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "DEBUG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG" + } + } + } + }, + "com.amazonaws.appsync#FieldLogLevel": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "DEBUG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG" + } + } + } + }, + "com.amazonaws.appsync#FlushApiCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#FlushApiCacheRequest" + }, + "output": { + "target": "com.amazonaws.appsync#FlushApiCacheResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Flushes an ApiCache object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input of a FlushApiCache operation.
Represents the output of a FlushApiCache operation.
A unique ID representing the Function object.
The Amazon Resource Name (ARN) of the Function object.
The name of the Function object.
The Function description.
The name of the DataSource.
The Function request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.
The Function response mapping template.
The version of the request mapping template. Currently, only the 2018-05-29 version of\n the template is supported.
" + } + }, + "syncConfig": { + "target": "com.amazonaws.appsync#SyncConfig" + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The function code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
A function is a reusable entity. You can use multiple functions to compose the resolver\n logic.
" + } + }, + "com.amazonaws.appsync#Functions": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#FunctionConfiguration" + } + }, + "com.amazonaws.appsync#FunctionsIds": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#String" + } + }, + "com.amazonaws.appsync#GetApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#GetApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#GetApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves an Api object.
Retrieves an ApiAssociation object.
The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetApiAssociationResponse": { + "type": "structure", + "members": { + "apiAssociation": { + "target": "com.amazonaws.appsync#ApiAssociation", + "traits": { + "smithy.api#documentation": "The ApiAssociation object.
Retrieves an ApiCache object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input of a GetApiCache operation.
The ApiCache object.
Represents the output of a GetApiCache operation.
The Api ID.
The Api object.
Retrieves the channel namespace for a specified Api.
The Api ID.
The name of the ChannelNamespace.
The ChannelNamespace object.
Retrieves a DataSource object.
Retrieves the record of an existing introspection. If the retrieval is successful, the\n result of the instrospection will also be returned. If the retrieval fails the operation,\n an error message will be returned instead.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/datasources/introspections/{introspectionId}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#GetDataSourceIntrospectionRequest": { + "type": "structure", + "members": { + "introspectionId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to\n reference the instrospection record.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "includeModelsSDL": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A boolean flag that determines whether SDL should be generated for introspected types.\n If set to true, each model will contain an sdl property that\n contains the SDL for that type. The SDL only contains the type data and no additional\n metadata or directives.
Determines the number of types to be returned in a single response before paginating.\n This value is typically taken from nextToken value from the previous\n response.
The maximum number of introspected types that will be returned in a single\n response.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetDataSourceIntrospectionResponse": { + "type": "structure", + "members": { + "introspectionId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to\n reference the instrospection record.
" + } + }, + "introspectionStatus": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionStatus", + "traits": { + "smithy.api#documentation": "The status of the introspection during retrieval. By default, when a new instrospection\n is being retrieved, the status will be set to PROCESSING. Once the operation\n has been completed, the status will change to SUCCESS or FAILED\n depending on how the data was parsed. A FAILED operation will return an error\n and its details as an introspectionStatusDetail.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail\n will also return the exact error that was generated during the operation.
The DataSourceIntrospectionResult object data.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.appsync#DataSource", + "traits": { + "smithy.api#documentation": "The DataSource object.
Retrieves a custom DomainName object.
The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetDomainNameResponse": { + "type": "structure", + "members": { + "domainNameConfig": { + "target": "com.amazonaws.appsync#DomainNameConfig", + "traits": { + "smithy.api#documentation": "The configuration for the DomainName.
Get a Function.
The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "functionId": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The Function ID.
The Function object.
Retrieves a GraphqlApi object.
Retrieves the list of environmental variable key-value pairs associated with an API by\n its ID value.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/environmentVariables", + "code": 200 + } + } + }, + "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariablesRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of the API from which the environmental variable list will be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariablesResponse": { + "type": "structure", + "members": { + "environmentVariables": { + "target": "com.amazonaws.appsync#EnvironmentVariableMap", + "traits": { + "smithy.api#documentation": "The payload containing each environmental variable in the \"key\" : \"value\"\n format.
The API ID for the GraphQL API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetGraphqlApiResponse": { + "type": "structure", + "members": { + "graphqlApi": { + "target": "com.amazonaws.appsync#GraphqlApi", + "traits": { + "smithy.api#documentation": "The GraphqlApi object.
Retrieves the introspection schema for a GraphQL API.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/schema", + "code": 200 + } + } + }, + "com.amazonaws.appsync#GetIntrospectionSchemaRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.appsync#OutputType", + "traits": { + "smithy.api#documentation": "The schema format: SDL or JSON.
", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + }, + "includeDirectives": { + "target": "com.amazonaws.appsync#BooleanValue", + "traits": { + "smithy.api#documentation": "A flag that specifies whether the schema introspection should contain directives.
", + "smithy.api#httpQuery": "includeDirectives" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetIntrospectionSchemaResponse": { + "type": "structure", + "members": { + "schema": { + "target": "com.amazonaws.appsync#Blob", + "traits": { + "smithy.api#documentation": "The schema, in GraphQL Schema Definition Language (SDL) format.
\nFor more information, see the GraphQL SDL\n documentation.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#GetResolver": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#GetResolverRequest" + }, + "output": { + "target": "com.amazonaws.appsync#GetResolverResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a Resolver object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fieldName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver field name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetResolverResponse": { + "type": "structure", + "members": { + "resolver": { + "target": "com.amazonaws.appsync#Resolver", + "traits": { + "smithy.api#documentation": "The Resolver object.
Retrieves the current status of a schema creation operation.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/schemacreation", + "code": 200 + } + } + }, + "com.amazonaws.appsync#GetSchemaCreationStatusRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetSchemaCreationStatusResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.appsync#SchemaStatus", + "traits": { + "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When\n the schema is in the ACTIVE state, you can add data.
" + } + }, + "details": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Detailed information about the status of the schema creation operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#GetSourceApiAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#GetSourceApiAssociationRequest" + }, + "output": { + "target": "com.amazonaws.appsync#GetSourceApiAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a SourceApiAssociation object.
The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetSourceApiAssociationResponse": { + "type": "structure", + "members": { + "sourceApiAssociation": { + "target": "com.amazonaws.appsync#SourceApiAssociation", + "traits": { + "smithy.api#documentation": "The SourceApiAssociation object data.
Retrieves a Type object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The type format: SDL or JSON.
", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetTypeResponse": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.appsync#Type", + "traits": { + "smithy.api#documentation": "The Type object.
The GraphQL schema is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appsync#GraphqlApi": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The API name.
" + } + }, + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
" + } + }, + "authenticationType": { + "target": "com.amazonaws.appsync#AuthenticationType", + "traits": { + "smithy.api#documentation": "The authentication type.
" + } + }, + "logConfig": { + "target": "com.amazonaws.appsync#LogConfig", + "traits": { + "smithy.api#documentation": "The Amazon CloudWatch Logs configuration.
" + } + }, + "userPoolConfig": { + "target": "com.amazonaws.appsync#UserPoolConfig", + "traits": { + "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" + } + }, + "openIDConnectConfig": { + "target": "com.amazonaws.appsync#OpenIDConnectConfig", + "traits": { + "smithy.api#documentation": "The OpenID Connect configuration.
" + } + }, + "arn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN).
" + } + }, + "uris": { + "target": "com.amazonaws.appsync#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The URIs.
" + } + }, + "tags": { + "target": "com.amazonaws.appsync#TagMap", + "traits": { + "smithy.api#documentation": "The tags.
" + } + }, + "additionalAuthenticationProviders": { + "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", + "traits": { + "smithy.api#documentation": "A list of additional authentication providers for the GraphqlApi\n API.
A flag indicating whether to use X-Ray tracing for this\n GraphqlApi.
The ARN of the WAF access control list (ACL) associated with this\n GraphqlApi, if one exists.
Configuration for Lambda function authorization.
" + } + }, + "dns": { + "target": "com.amazonaws.appsync#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The DNS records for the API.
" + } + }, + "visibility": { + "target": "com.amazonaws.appsync#GraphQLApiVisibility", + "traits": { + "smithy.api#documentation": "Sets the value of the GraphQL API to public (GLOBAL) or private\n (PRIVATE). If no value is provided, the visibility will be set to\n GLOBAL by default. This value cannot be changed once the API has been\n created.
The value that indicates whether the GraphQL API is a standard API\n (GRAPHQL) or merged API (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync\n service assumes this role on behalf of the Merged API to validate access to source APIs at\n runtime and to prompt the AUTO_MERGE to update the merged API endpoint with\n the source API changes automatically.
The account owner of the GraphQL API.
" + } + }, + "ownerContact": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" + } + }, + "introspectionConfig": { + "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", + "traits": { + "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable\n (DISABLED) introspection. If no value is provided, the introspection\n configuration will be set to ENABLED by default. This field will produce an\n error if the operation attempts to use the introspection feature while this field is\n disabled.
For more information about introspection, see GraphQL introspection.
" + } + }, + "queryDepthLimit": { + "target": "com.amazonaws.appsync#QueryDepthLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of\n nested levels allowed in the body of query. The default value is 0 (or\n unspecified), which indicates there's no depth limit. If you set a limit, it can be between\n 1 and 75 nested levels. This field will produce a limit error\n if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field\n produces an error, the error will be thrown upwards to the first nullable field\n available.
" + } + }, + "resolverCountLimit": { + "target": "com.amazonaws.appsync#ResolverCountLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default\n value is 0 (or unspecified), which will set the limit to 10000.\n When specified, the limit value can be between 1 and 10000. This\n field will produce a limit error if the operation falls out of bounds.
The enhancedMetricsConfig object.
Describes a GraphQL API.
" + } + }, + "com.amazonaws.appsync#GraphqlApis": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#GraphqlApi" + } + }, + "com.amazonaws.appsync#HttpDataSourceConfig": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The HTTP URL endpoint. You can specify either the domain name or IP, and port\n combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port,\n AppSync uses the default port 80 for the HTTP endpoint and port 443 for\n HTTPS endpoints.
" + } + }, + "authorizationConfig": { + "target": "com.amazonaws.appsync#AuthorizationConfig", + "traits": { + "smithy.api#documentation": "The authorization configuration in case the HTTP endpoint requires authorization.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an HTTP data source configuration.
" + } + }, + "com.amazonaws.appsync#InternalFailureException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "An internal AppSync error occurred. Try your request again.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.appsync#LambdaAuthorizerConfig": { + "type": "structure", + "members": { + "authorizerResultTtlInSeconds": { + "target": "com.amazonaws.appsync#TTL", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of seconds a response should be cached for. The default is 0 seconds, which\n disables caching. If you don't specify a value for\n authorizerResultTtlInSeconds, the default value is used. The maximum value\n is one hour (3600 seconds). The Lambda function can override this by returning\n a ttlOverride key in its response.
The Amazon Resource Name (ARN) of the Lambda function to be called for\n authorization. This can be a standard Lambda ARN, a version ARN\n (.../v3), or an alias ARN.
\n Note: This Lambda function must have the\n following resource-based policy assigned to it. When configuring Lambda\n authorizers in the console, this is done for you. To use the Command Line Interface\n (CLI), run the following:
\n\n aws lambda add-permission --function-name\n \"arn:aws:lambda:us-east-2:111122223333:function:my-function\" --statement-id \"appsync\"\n --principal appsync.amazonaws.com --action lambda:InvokeFunction\n
A regular expression for validation of tokens before the Lambda function is\n called.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A LambdaAuthorizerConfig specifies how to authorize AppSync\n API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a\n time.
The Amazon Resource Name (ARN) for the Lambda function to use as the\n Conflict Handler.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The LambdaConflictHandlerConfig object when configuring LAMBDA\n as the Conflict Handler.
The Amazon Resource Name (ARN) for the Lambda function.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Lambda data source configuration.
" + } + }, + "com.amazonaws.appsync#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "The request exceeded a limit. Try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.appsync#ListApiKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListApiKeysRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListApiKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the API keys for a given API.
\nAPI keys are deleted automatically 60 days after they expire. However, they may still\n be included in the response until they have actually been deleted. You can safely call\n DeleteApiKey to manually delete a key before it's automatically\n deleted.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListApiKeysResponse": { + "type": "structure", + "members": { + "apiKeys": { + "target": "com.amazonaws.appsync#ApiKeys", + "traits": { + "smithy.api#documentation": "The ApiKey objects.
An identifier to pass in the next request to this operation to return the next set of\n items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListApis": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListApisRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListApisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the APIs in your AppSync account.
\n\n ListApis returns only the high level API details. For more detailed\n information about an API, use GetApi.
An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListApisResponse": { + "type": "structure", + "members": { + "apis": { + "target": "com.amazonaws.appsync#Apis", + "traits": { + "smithy.api#documentation": "The Api objects.
An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListChannelNamespaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListChannelNamespacesRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListChannelNamespacesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the channel namespaces for a specified Api.
\n ListChannelNamespaces returns only high level details for the channel\n namespace. To retrieve code handlers, use\n GetChannelNamespace.
The Api ID.
An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListChannelNamespacesResponse": { + "type": "structure", + "members": { + "channelNamespaces": { + "target": "com.amazonaws.appsync#ChannelNamespaces", + "traits": { + "smithy.api#documentation": "The ChannelNamespace objects.
An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListDataSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the data sources for a given API.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/datasources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "dataSources", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListDataSourcesRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListDataSourcesResponse": { + "type": "structure", + "members": { + "dataSources": { + "target": "com.amazonaws.appsync#DataSources", + "traits": { + "smithy.api#documentation": "The DataSource objects.
An identifier to pass in the next request to this operation to return the next set of\n items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListDomainNames": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListDomainNamesRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListDomainNamesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + } + ], + "traits": { + "smithy.api#documentation": "Lists multiple custom domain names.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/domainnames", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "domainNameConfigs", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListDomainNamesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListDomainNamesResponse": { + "type": "structure", + "members": { + "domainNameConfigs": { + "target": "com.amazonaws.appsync#DomainNameConfigs", + "traits": { + "smithy.api#documentation": "Lists configurations for multiple domain names.
" + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListFunctions": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListFunctionsRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListFunctionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "List multiple functions.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/functions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "functions", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListFunctionsRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListFunctionsResponse": { + "type": "structure", + "members": { + "functions": { + "target": "com.amazonaws.appsync#Functions", + "traits": { + "smithy.api#documentation": "A list of Function objects.
An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListGraphqlApis": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListGraphqlApisRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListGraphqlApisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists your GraphQL APIs.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "graphqlApis", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListGraphqlApisRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "apiType": { + "target": "com.amazonaws.appsync#GraphQLApiType", + "traits": { + "smithy.api#documentation": "The value that indicates whether the GraphQL API is a standard API\n (GRAPHQL) or merged API (MERGED).
The account owner of the GraphQL API.
", + "smithy.api#httpQuery": "owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListGraphqlApisResponse": { + "type": "structure", + "members": { + "graphqlApis": { + "target": "com.amazonaws.appsync#GraphqlApis", + "traits": { + "smithy.api#documentation": "The GraphqlApi objects.
An identifier to pass in the next request to this operation to return the next set of\n items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListResolvers": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListResolversRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListResolversResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the resolvers for a given API and type.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "resolvers", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListResolversByFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListResolversByFunctionRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListResolversByFunctionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "List the resolvers that are associated with a specific function.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/functions/{functionId}/resolvers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "resolvers", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListResolversByFunctionRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "functionId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The function ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListResolversByFunctionResponse": { + "type": "structure", + "members": { + "resolvers": { + "target": "com.amazonaws.appsync#Resolvers", + "traits": { + "smithy.api#documentation": "The list of resolvers.
" + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that you can use to return the next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListResolversRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListResolversResponse": { + "type": "structure", + "members": { + "resolvers": { + "target": "com.amazonaws.appsync#Resolvers", + "traits": { + "smithy.api#documentation": "The Resolver objects.
An identifier to pass in the next request to this operation to return the next set of\n items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListSourceApiAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListSourceApiAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListSourceApiAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the SourceApiAssociationSummary data.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListSourceApiAssociationsResponse": { + "type": "structure", + "members": { + "sourceApiAssociationSummaries": { + "target": "com.amazonaws.appsync#SourceApiAssociationSummaryList", + "traits": { + "smithy.api#documentation": "The SourceApiAssociationSummary object data.
An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#LimitExceededException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags for a resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.appsync#ResourceArn", + "traits": { + "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A TagMap object.
Lists the types for a given API.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/types", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "types", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListTypesByAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListTypesByAssociationRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListTypesByAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Type objects by the source API association ID.
The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The format type.
", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListTypesByAssociationResponse": { + "type": "structure", + "members": { + "types": { + "target": "com.amazonaws.appsync#TypeList", + "traits": { + "smithy.api#documentation": "The Type objects.
An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListTypesRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The type format: SDL or JSON.
", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListTypesResponse": { + "type": "structure", + "members": { + "types": { + "target": "com.amazonaws.appsync#TypeList", + "traits": { + "smithy.api#documentation": "The Type objects.
An identifier to pass in the next request to this operation to return the next set of\n items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#LogConfig": { + "type": "structure", + "members": { + "fieldLogLevel": { + "target": "com.amazonaws.appsync#FieldLogLevel", + "traits": { + "smithy.api#documentation": "The field logging level. Values can be NONE, ERROR, or ALL.
\n\n NONE: No field-level logs are\n captured.
\n\n ERROR: Logs the following information only for\n the fields that are in error:
\nThe error section in the server response.
\nField-level errors.
\nThe generated request/response functions that got resolved for error\n fields.
\n\n ALL: The following information is logged for\n all fields in the query:
\nField-level tracing information.
\nThe generated request/response functions that got resolved for each\n field.
\nThe service role that AppSync assumes to publish to CloudWatch\n logs in your account.
", + "smithy.api#required": {} + } + }, + "excludeVerboseContent": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Set to TRUE to exclude sections that contain information such as headers, context, and\n evaluated mapping templates, regardless of logging level.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon CloudWatch Logs configuration.
" + } + }, + "com.amazonaws.appsync#Logs": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#String" + } + }, + "com.amazonaws.appsync#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.appsync#MapOfStringToString": { + "type": "map", + "key": { + "target": "com.amazonaws.appsync#String" + }, + "value": { + "target": "com.amazonaws.appsync#String" + } + }, + "com.amazonaws.appsync#MappingTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.appsync#MaxBatchSize": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.appsync#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.appsync#MergeType": { + "type": "enum", + "members": { + "MANUAL_MERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL_MERGE" + } + }, + "AUTO_MERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_MERGE" + } + } + } + }, + "com.amazonaws.appsync#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,48}[A-Za-z0-9])?)$" + } + }, + "com.amazonaws.appsync#NotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "The resource specified in the request was not found. Check the resource, and then try\n again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.appsync#OpenIDConnectConfig": { + "type": "structure", + "members": { + "issuer": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The issuer for the OIDC configuration. The issuer returned by discovery must exactly\n match the value of iss in the ID token.
The client identifier of the relying party at the OpenID identity provider. This\n identifier is typically obtained when the relying party is registered with the OpenID\n identity provider. You can specify a regular expression so that AppSync can\n validate against multiple client identifiers at a time.
" + } + }, + "iatTTL": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of milliseconds that a token is valid after it's issued to a user.
" + } + }, + "authTTL": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of milliseconds that a token is valid after being authenticated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an OpenID Connect (OIDC) configuration.
" + } + }, + "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The endpoint.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an OpenSearch data source configuration.
" + } + }, + "com.amazonaws.appsync#OperationLevelMetricsConfig": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.appsync#OutputType": { + "type": "enum", + "members": { + "SDL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SDL" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.appsync#OwnerContact": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + }, + "smithy.api#pattern": "^[A-Za-z0-9_\\-\\ \\.]+$" + } + }, + "com.amazonaws.appsync#Ownership": { + "type": "enum", + "members": { + "CURRENT_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURRENT_ACCOUNT" + } + }, + "OTHER_ACCOUNTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER_ACCOUNTS" + } + } + } + }, + "com.amazonaws.appsync#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.appsync#PipelineConfig": { + "type": "structure", + "members": { + "functions": { + "target": "com.amazonaws.appsync#FunctionsIds", + "traits": { + "smithy.api#documentation": "A list of Function objects.
The pipeline configuration for a resolver of kind PIPELINE.
Creates a list of environmental variables in an API by its ID value.
\nWhen creating an environmental variable, it must follow the constraints below:
\nBoth JavaScript and VTL templates support environmental variables.
\nEnvironmental variables are not evaluated before function invocation.
\nEnvironmental variables only support string values.
\nAny defined value in an environmental variable is considered a string literal\n and not expanded.
\nVariable evaluations should ideally be performed in the function\n code.
\nWhen creating an environmental variable key-value pair, it must follow the additional\n constraints below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character\n (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the\n environmentVariables payload as a list in the format\n {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of\n the existing environmental variable list of that API. This means the existing environmental\n variables will be lost. To avoid this, you must include all existing and new environmental\n variables in the list each time you call this action.
The ID of the API to which the environmental variable list will be written.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentVariables": { + "target": "com.amazonaws.appsync#EnvironmentVariableMap", + "traits": { + "smithy.api#documentation": "The list of environmental variables to add to the API.
\nWhen creating an environmental variable key-value pair, it must follow the additional\n constraints below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character\n (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the\n environmentVariables payload as a list in the format\n {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of\n the existing environmental variable list of that API. This means the existing environmental\n variables will be lost. To avoid this, you must include all existing and new environmental\n variables in the list each time you call this action.
The payload containing each environmental variable in the \"key\" : \"value\"\n format.
The resource ARN of the RDS cluster.
", + "smithy.api#required": {} + } + }, + "secretArn": { + "target": "com.amazonaws.appsync#RdsDataApiConfigSecretArn", + "traits": { + "smithy.api#documentation": "The secret's ARN that was obtained from Secrets Manager. A secret consists of secret\n information, the secret value, plus metadata about the secret. A secret value can be a\n string or binary. It typically includes the ARN, secret name and description, policies,\n tags, encryption key from the Key Management Service, and key rotation data.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.appsync#RdsDataApiConfigDatabaseName", + "traits": { + "smithy.api#documentation": "The name of the database in the cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the metadata required to introspect the RDS cluster.
" + } + }, + "com.amazonaws.appsync#RdsDataApiConfigDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.appsync#RdsDataApiConfigResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z-]*:rds:[a-z0-9-]*:\\d{12}:cluster:[0-9A-Za-z_/-]*$" + } + }, + "com.amazonaws.appsync#RdsDataApiConfigSecretArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z-]*:secretsmanager:[a-z0-9-]*:\\d{12}:secret:[0-9A-Za-z_/+=.@!-]*$" + } + }, + "com.amazonaws.appsync#RdsHttpEndpointConfig": { + "type": "structure", + "members": { + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Amazon Web Services Region for Amazon RDS HTTP endpoint.
" + } + }, + "dbClusterIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Amazon RDS cluster Amazon Resource Name (ARN).
" + } + }, + "databaseName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Logical database name.
" + } + }, + "schema": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Logical schema name.
" + } + }, + "awsSecretStoreArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Amazon Web Services secret store Amazon Resource Name (ARN) for database\n credentials.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.
" + } + }, + "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig": { + "type": "structure", + "members": { + "relationalDatabaseSourceType": { + "target": "com.amazonaws.appsync#RelationalDatabaseSourceType", + "traits": { + "smithy.api#documentation": "Source type for the relational database.
\n\n RDS_HTTP_ENDPOINT: The relational database\n source type is an Amazon Relational Database Service (Amazon RDS) HTTP\n endpoint.
\nAmazon RDS HTTP endpoint settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a relational database data source configuration.
" + } + }, + "com.amazonaws.appsync#RelationalDatabaseSourceType": { + "type": "enum", + "members": { + "RDS_HTTP_ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_HTTP_ENDPOINT" + } + } + } + }, + "com.amazonaws.appsync#Resolver": { + "type": "structure", + "members": { + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver type name.
" + } + }, + "fieldName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver field name.
" + } + }, + "dataSourceName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver data source name.
" + } + }, + "resolverArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The resolver Amazon Resource Name (ARN).
" + } + }, + "requestMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The request mapping template.
" + } + }, + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The response mapping template.
" + } + }, + "kind": { + "target": "com.amazonaws.appsync#ResolverKind", + "traits": { + "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. You can use a UNIT resolver to run a GraphQL query against\n a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can\n use a PIPELINE resolver to invoke a series of Function objects in a\n serial manner. You can use a pipeline resolver to run a GraphQL query against\n multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" + } + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The resolver code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that\n metricsConfig won't be used unless the\n resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is\n set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will\n be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Describes a resolver.
" + } + }, + "com.amazonaws.appsync#ResolverCountLimit": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 10000 + } + } + }, + "com.amazonaws.appsync#ResolverKind": { + "type": "enum", + "members": { + "UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNIT" + } + }, + "PIPELINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIPELINE" + } + } + } + }, + "com.amazonaws.appsync#ResolverLevelMetricsBehavior": { + "type": "enum", + "members": { + "FULL_REQUEST_RESOLVER_METRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "PER_RESOLVER_METRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PER_RESOLVER_METRICS" + } + } + } + }, + "com.amazonaws.appsync#ResolverLevelMetricsConfig": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.appsync#Resolvers": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#Resolver" + } + }, + "com.amazonaws.appsync#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 70, + "max": 75 + }, + "smithy.api#pattern": "^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\\d{12}:apis/[0-9A-Za-z_-]{26}$" + } + }, + "com.amazonaws.appsync#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#pattern": "^[_A-Za-z][_0-9A-Za-z]*$" + } + }, + "com.amazonaws.appsync#RuntimeName": { + "type": "enum", + "members": { + "APPSYNC_JS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPSYNC_JS" + } + } + } + }, + "com.amazonaws.appsync#SchemaStatus": { + "type": "enum", + "members": { + "Processing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "NotApplicable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_APPLICABLE" + } + } + } + }, + "com.amazonaws.appsync#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "The operation exceeded the service quota for this resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.appsync#SourceApiAssociation": { + "type": "structure", + "members": { + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
" + } + }, + "associationArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source API association.
" + } + }, + "sourceApiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of the AppSync source API.
" + } + }, + "sourceApiArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync source API.
" + } + }, + "mergedApiArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Merged API.
" + } + }, + "mergedApiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of the AppSync Merged API.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description field.
" + } + }, + "sourceApiAssociationConfig": { + "target": "com.amazonaws.appsync#SourceApiAssociationConfig", + "traits": { + "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The state of the source API association.
" + } + }, + "sourceApiAssociationStatusDetail": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The detailed message related to the current state of the source API association.
" + } + }, + "lastSuccessfulMergeDate": { + "target": "com.amazonaws.appsync#Date", + "traits": { + "smithy.api#documentation": "The datetime value of the last successful merge of the source API association. The\n result will be in UTC format and your local time zone.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration of a source API. A source API is a GraphQL API that is\n linked to a merged API. There can be multiple source APIs attached to each merged API. When\n linked to a merged API, the source API's schema, data sources, and resolvers will be\n combined with other linked source API data to form a new, singular API.
\nSource 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\n accounts, see What is Amazon Web Services Resource Access Manager? in the Amazon Web Services Resource Access Manager guide.
" + } + }, + "com.amazonaws.appsync#SourceApiAssociationConfig": { + "type": "structure", + "members": { + "mergeType": { + "target": "com.amazonaws.appsync#MergeType", + "traits": { + "smithy.api#documentation": "The property that indicates which merging option is enabled in the source API\n association.
\nValid merge types are MANUAL_MERGE (default) and AUTO_MERGE.\n Manual merges are the default behavior and require the user to trigger any changes from the\n source APIs to the merged API manually. Auto merges subscribe the merged API to the changes\n performed on the source APIs so that any change in the source APIs are also made to the\n merged API. Auto merges use MergedApiExecutionRoleArn to perform merge\n operations.
Describes properties used to specify configurations related to a source API.
" + } + }, + "com.amazonaws.appsync#SourceApiAssociationStatus": { + "type": "enum", + "members": { + "MERGE_SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MERGE_SCHEDULED" + } + }, + "MERGE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MERGE_FAILED" + } + }, + "MERGE_SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MERGE_SUCCESS" + } + }, + "MERGE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MERGE_IN_PROGRESS" + } + }, + "AUTO_MERGE_SCHEDULE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_MERGE_SCHEDULE_FAILED" + } + }, + "DELETION_SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_SCHEDULED" + } + }, + "DELETION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_IN_PROGRESS" + } + }, + "DELETION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_FAILED" + } + } + } + }, + "com.amazonaws.appsync#SourceApiAssociationSummary": { + "type": "structure", + "members": { + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
" + } + }, + "associationArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source API association.
" + } + }, + "sourceApiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of the AppSync source API.
" + } + }, + "sourceApiArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Source API.
" + } + }, + "mergedApiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of the AppSync Merged API.
" + } + }, + "mergedApiArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Merged API.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description field.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the ARNs and IDs of associations, Merged APIs, and source APIs.
" + } + }, + "com.amazonaws.appsync#SourceApiAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#SourceApiAssociationSummary" + } + }, + "com.amazonaws.appsync#StartDataSourceIntrospection": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#StartDataSourceIntrospectionRequest" + }, + "output": { + "target": "com.amazonaws.appsync#StartDataSourceIntrospectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new introspection. Returns the introspectionId of the new\n introspection after its creation.
The rdsDataApiConfig object data.
The introspection ID. Each introspection contains a unique ID that can be used to\n reference the instrospection record.
" + } + }, + "introspectionStatus": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionStatus", + "traits": { + "smithy.api#documentation": "The status of the introspection during creation. By default, when a new instrospection\n has been created, the status will be set to PROCESSING. Once the operation has\n been completed, the status will change to SUCCESS or FAILED\n depending on how the data was parsed. A FAILED operation will return an error\n and its details as an introspectionStatusDetail.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail\n will also return the exact error that was generated during the operation.
Adds a new schema to your GraphQL API.
\nThis operation is asynchronous. Use to\n determine when it has completed.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/schemacreation", + "code": 200 + } + } + }, + "com.amazonaws.appsync#StartSchemaCreationRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.appsync#Blob", + "traits": { + "smithy.api#documentation": "The schema definition, in GraphQL schema language format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#StartSchemaCreationResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.appsync#SchemaStatus", + "traits": { + "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When\n the schema is in the ACTIVE state, you can add data.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#StartSchemaMerge": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#StartSchemaMergeRequest" + }, + "output": { + "target": "com.amazonaws.appsync#StartSchemaMergeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Initiates a merge operation. Returns a status that shows the result of the merge\n operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}/merge", + "code": 200 + } + } + }, + "com.amazonaws.appsync#StartSchemaMergeRequest": { + "type": "structure", + "members": { + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "mergedApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#StartSchemaMergeResponse": { + "type": "structure", + "members": { + "sourceApiAssociationStatus": { + "target": "com.amazonaws.appsync#SourceApiAssociationStatus", + "traits": { + "smithy.api#documentation": "The state of the source API association.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#String": { + "type": "string" + }, + "com.amazonaws.appsync#SyncConfig": { + "type": "structure", + "members": { + "conflictHandler": { + "target": "com.amazonaws.appsync#ConflictHandlerType", + "traits": { + "smithy.api#documentation": "The Conflict Resolution strategy to perform in the event of a conflict.
\n\n OPTIMISTIC_CONCURRENCY: Resolve conflicts by\n rejecting mutations when versions don't match the latest version at the\n server.
\n\n AUTOMERGE: Resolve conflicts with the\n Automerge conflict resolution strategy.
\n\n LAMBDA: Resolve conflicts with an Lambda function supplied in the\n LambdaConflictHandlerConfig.
The Conflict Detection strategy to use.
\n\n VERSION: Detect conflicts based on object\n versions for this resolver.
\n\n NONE: Do not detect conflicts when invoking\n this resolver.
\nThe LambdaConflictHandlerConfig when configuring LAMBDA as the\n Conflict Handler.
Describes a Sync configuration for a resolver.
\nSpecifies which Conflict Detection strategy and Resolution strategy to use when the\n resolver is invoked.
" + } + }, + "com.amazonaws.appsync#TTL": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "com.amazonaws.appsync#TagKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "The key for the tag.
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[ a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.appsync#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.appsync#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appsync#TagKey" + }, + "value": { + "target": "com.amazonaws.appsync#TagValue" + }, + "traits": { + "smithy.api#documentation": "A map with keys of TagKey objects and values of TagValue\n objects.
Tags a resource with user-supplied tags.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.appsync#ResourceArn", + "traits": { + "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A TagMap object.
The value for the tag.
", + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\s\\w+-=\\.:/@]*$" + } + }, + "com.amazonaws.appsync#Template": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 65536 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.appsync#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.appsync#Type": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The type name.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The type description.
" + } + }, + "arn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The type Amazon Resource Name (ARN).
" + } + }, + "definition": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The type definition.
" + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The type format: SDL or JSON.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a type.
" + } + }, + "com.amazonaws.appsync#TypeDefinitionFormat": { + "type": "enum", + "members": { + "SDL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SDL" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.appsync#TypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#Type" + } + }, + "com.amazonaws.appsync#UnauthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "You aren't authorized to perform this operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.appsync#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.appsync#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#LimitExceededException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Untags a resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.appsync#ResourceArn", + "traits": { + "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A list of TagKey objects.
Updates an Api.
Updates the cache for the GraphQL API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/ApiCaches/update", + "code": 200 + } + } + }, + "com.amazonaws.appsync#UpdateApiCacheRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ttl": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
", + "smithy.api#required": {} + } + }, + "apiCachingBehavior": { + "target": "com.amazonaws.appsync#ApiCachingBehavior", + "traits": { + "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully\n cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers\n that you specify are cached.
\nThe cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics\n include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the\n throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing\n bottlenecks in a cache configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis\n process. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
Represents the input of a UpdateApiCache operation.
The ApiCache object.
Represents the output of a UpdateApiCache operation.
Updates an API key. You can update the key as long as it's not deleted.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/apikeys/{id}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#UpdateApiKeyRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID for the GraphQL API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API key ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A description of the purpose of the API key.
" + } + }, + "expires": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "From the update time, the time after which the API key expires. The date is represented\n as seconds since the epoch. For more information, see .
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#UpdateApiKeyResponse": { + "type": "structure", + "members": { + "apiKey": { + "target": "com.amazonaws.appsync#ApiKey", + "traits": { + "smithy.api#documentation": "The API key.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#UpdateApiRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Api ID.
The name of the Api.
", + "smithy.api#required": {} + } + }, + "ownerContact": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The owner contact information for the Api.
The new event configuration. This includes the default authorization configuration for\n connecting, publishing, and subscribing to an Event API.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#UpdateApiResponse": { + "type": "structure", + "members": { + "api": { + "target": "com.amazonaws.appsync#Api", + "traits": { + "smithy.api#documentation": "The Api object.
Updates a ChannelNamespace associated with an Api.
The Api ID.
The name of the ChannelNamespace.
The authorization mode to use for subscribing to messages on the channel namespace. This\n configuration overrides the default Api authorization configuration.
The authorization mode to use for publishing messages on the channel namespace. This\n configuration overrides the default Api authorization configuration.
The event handler functions that run custom business logic to process published events\n and subscribe requests.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#UpdateChannelNamespaceResponse": { + "type": "structure", + "members": { + "channelNamespace": { + "target": "com.amazonaws.appsync#ChannelNamespace", + "traits": { + "smithy.api#documentation": "The ChannelNamespace object.
Updates a DataSource object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The new name for the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The new description for the data source.
" + } + }, + "type": { + "target": "com.amazonaws.appsync#DataSourceType", + "traits": { + "smithy.api#documentation": "The new data source type.
", + "smithy.api#required": {} + } + }, + "serviceRoleArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The new service role Amazon Resource Name (ARN) for the data source.
" + } + }, + "dynamodbConfig": { + "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new Amazon DynamoDB configuration.
" + } + }, + "lambdaConfig": { + "target": "com.amazonaws.appsync#LambdaDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new Lambda configuration.
" + } + }, + "elasticsearchConfig": { + "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new OpenSearch configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This\n configuration is deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.
" + } + }, + "openSearchServiceConfig": { + "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new OpenSearch configuration.
" + } + }, + "httpConfig": { + "target": "com.amazonaws.appsync#HttpDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new HTTP endpoint configuration.
" + } + }, + "relationalDatabaseConfig": { + "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new relational database configuration.
" + } + }, + "eventBridgeConfig": { + "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new Amazon EventBridge settings.
" + } + }, + "metricsConfig": { + "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", + "traits": { + "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the\n dataSourceLevelMetricsBehavior value is set to\n PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior\n is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig\n will be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The updated DataSource object.
Updates a custom DomainName object.
The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#Description", + "traits": { + "smithy.api#documentation": "A description of the DomainName.
The configuration for the DomainName.
Updates a Function object.
The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The Function name.
The Function description.
The function ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The Function\n DataSource name.
The Function request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.
The Function request mapping template.
The version of the request mapping template. Currently, the supported value\n is 2018-05-29. Note that when using VTL and mapping templates, the\n functionVersion is required.
The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The function code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
The Function object.
Updates a GraphqlApi object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The new name for the GraphqlApi object.
The Amazon CloudWatch Logs configuration for the GraphqlApi object.
The new authentication type for the GraphqlApi object.
The new Amazon Cognito user pool configuration for the ~GraphqlApi\n object.
The OpenID Connect configuration for the GraphqlApi object.
A list of additional authentication providers for the GraphqlApi\n API.
A flag indicating whether to use X-Ray tracing for the\n GraphqlApi.
Configuration for Lambda function authorization.
" + } + }, + "mergedApiExecutionRoleArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Identity and Access Management service role ARN for a merged API. The AppSync\n service assumes this role on behalf of the Merged API to validate access to source APIs at\n runtime and to prompt the AUTO_MERGE to update the merged API endpoint with\n the source API changes automatically.
The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" + } + }, + "introspectionConfig": { + "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", + "traits": { + "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable\n (DISABLED) introspection. If no value is provided, the introspection\n configuration will be set to ENABLED by default. This field will produce an\n error if the operation attempts to use the introspection feature while this field is\n disabled.
For more information about introspection, see GraphQL introspection.
" + } + }, + "queryDepthLimit": { + "target": "com.amazonaws.appsync#QueryDepthLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of\n nested levels allowed in the body of query. The default value is 0 (or\n unspecified), which indicates there's no depth limit. If you set a limit, it can be between\n 1 and 75 nested levels. This field will produce a limit error\n if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field\n produces an error, the error will be thrown upwards to the first nullable field\n available.
" + } + }, + "resolverCountLimit": { + "target": "com.amazonaws.appsync#ResolverCountLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default\n value is 0 (or unspecified), which will set the limit to 10000.\n When specified, the limit value can be between 1 and 10000. This\n field will produce a limit error if the operation falls out of bounds.
The enhancedMetricsConfig object.
The updated GraphqlApi object.
Updates a Resolver object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The new type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fieldName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The new field name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The new data source name.
" + } + }, + "requestMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The new request mapping template.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data\n source. For all other data sources, VTL request and response mapping templates are\n required.
" + } + }, + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The new response mapping template.
" + } + }, + "kind": { + "target": "com.amazonaws.appsync#ResolverKind", + "traits": { + "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. You can use a UNIT resolver to run a GraphQL query against\n a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can\n use a PIPELINE resolver to invoke a series of Function objects in a\n serial manner. You can use a pipeline resolver to run a GraphQL query against\n multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" + } + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The resolver code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that\n metricsConfig won't be used unless the\n resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is\n set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will\n be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The updated Resolver object.
Updates some of the configuration choices of a particular source API association.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#UpdateSourceApiAssociationRequest": { + "type": "structure", + "members": { + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "mergedApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description field.
" + } + }, + "sourceApiAssociationConfig": { + "target": "com.amazonaws.appsync#SourceApiAssociationConfig", + "traits": { + "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
Updates a Type object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The new type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The new definition.
" + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The new type format: SDL or JSON.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#UpdateTypeResponse": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.appsync#Type", + "traits": { + "smithy.api#documentation": "The updated Type object.
The user pool ID.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region in which the user pool was created.
", + "smithy.api#required": {} + } + }, + "defaultAction": { + "target": "com.amazonaws.appsync#DefaultAction", + "traits": { + "smithy.api#documentation": "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\n configuration.
", + "smithy.api#required": {} + } + }, + "appIdClientRegex": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client\n ID. If this value isn't set, no filtering is applied.
" + } } + }, + "traits": { + "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" + } } + } }