import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { APIGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../APIGatewayClient"; import type { GatewayResponse, UpdateGatewayResponseRequest } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateGatewayResponseCommand}. */ export interface UpdateGatewayResponseCommandInput extends UpdateGatewayResponseRequest { } /** * @public * * The output of {@link UpdateGatewayResponseCommand}. */ export interface UpdateGatewayResponseCommandOutput extends GatewayResponse, __MetadataBearer { } declare const UpdateGatewayResponseCommand_base: { new (input: UpdateGatewayResponseCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: UpdateGatewayResponseCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Updates a GatewayResponse of a specified response type on the given RestApi.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { APIGatewayClient, UpdateGatewayResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import * // const { APIGatewayClient, UpdateGatewayResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import * // import type { APIGatewayClientConfig } from "@aws-sdk/client-api-gateway"; * const config = {}; // type is APIGatewayClientConfig * const client = new APIGatewayClient(config); * const input = { // UpdateGatewayResponseRequest * restApiId: "STRING_VALUE", // required * responseType: "DEFAULT_4XX" || "DEFAULT_5XX" || "RESOURCE_NOT_FOUND" || "UNAUTHORIZED" || "INVALID_API_KEY" || "ACCESS_DENIED" || "AUTHORIZER_FAILURE" || "AUTHORIZER_CONFIGURATION_ERROR" || "INVALID_SIGNATURE" || "EXPIRED_TOKEN" || "MISSING_AUTHENTICATION_TOKEN" || "INTEGRATION_FAILURE" || "INTEGRATION_TIMEOUT" || "API_CONFIGURATION_ERROR" || "UNSUPPORTED_MEDIA_TYPE" || "BAD_REQUEST_PARAMETERS" || "BAD_REQUEST_BODY" || "REQUEST_TOO_LARGE" || "THROTTLED" || "QUOTA_EXCEEDED" || "WAF_FILTERED", // required * patchOperations: [ // ListOfPatchOperation * { // PatchOperation * op: "add" || "remove" || "replace" || "move" || "copy" || "test", * path: "STRING_VALUE", * value: "STRING_VALUE", * from: "STRING_VALUE", * }, * ], * }; * const command = new UpdateGatewayResponseCommand(input); * const response = await client.send(command); * // { // GatewayResponse * // responseType: "DEFAULT_4XX" || "DEFAULT_5XX" || "RESOURCE_NOT_FOUND" || "UNAUTHORIZED" || "INVALID_API_KEY" || "ACCESS_DENIED" || "AUTHORIZER_FAILURE" || "AUTHORIZER_CONFIGURATION_ERROR" || "INVALID_SIGNATURE" || "EXPIRED_TOKEN" || "MISSING_AUTHENTICATION_TOKEN" || "INTEGRATION_FAILURE" || "INTEGRATION_TIMEOUT" || "API_CONFIGURATION_ERROR" || "UNSUPPORTED_MEDIA_TYPE" || "BAD_REQUEST_PARAMETERS" || "BAD_REQUEST_BODY" || "REQUEST_TOO_LARGE" || "THROTTLED" || "QUOTA_EXCEEDED" || "WAF_FILTERED", * // statusCode: "STRING_VALUE", * // responseParameters: { // MapOfStringToString * // "": "STRING_VALUE", * // }, * // responseTemplates: { * // "": "STRING_VALUE", * // }, * // defaultResponse: true || false, * // }; * * ``` * * @param UpdateGatewayResponseCommandInput - {@link UpdateGatewayResponseCommandInput} * @returns {@link UpdateGatewayResponseCommandOutput} * @see {@link UpdateGatewayResponseCommandInput} for command's `input` shape. * @see {@link UpdateGatewayResponseCommandOutput} for command's `response` shape. * @see {@link APIGatewayClientResolvedConfig | config} for APIGatewayClient's `config` shape. * * @throws {@link BadRequestException} (client fault) *

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

* * @throws {@link ConflictException} (client fault) *

The request configuration has conflicts. For details, see the accompanying error message.

* * @throws {@link LimitExceededException} (client fault) *

The request exceeded the rate limit. Retry after the specified time period.

* * @throws {@link NotFoundException} (client fault) *

The requested resource is not found. Make sure that the request URI is correct.

* * @throws {@link TooManyRequestsException} (client fault) *

The request has reached its throttling limit. Retry after the specified time period.

* * @throws {@link UnauthorizedException} (client fault) *

The request is denied because the caller has insufficient permissions.

* * @throws {@link APIGatewayServiceException} *

Base exception class for all service exceptions from APIGateway service.

* * * @public */ export declare class UpdateGatewayResponseCommand extends UpdateGatewayResponseCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateGatewayResponseRequest; output: GatewayResponse; }; sdk: { input: UpdateGatewayResponseCommandInput; output: UpdateGatewayResponseCommandOutput; }; }; }