import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { UpdateEndpointRequest, UpdateEndpointResponse } from "../models/models_1"; import type { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateEndpointCommand}. */ export interface UpdateEndpointCommandInput extends UpdateEndpointRequest { } /** * @public * * The output of {@link UpdateEndpointCommand}. */ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __MetadataBearer { } declare const UpdateEndpointCommand_base: { new (input: UpdateEndpointCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: UpdateEndpointCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { PinpointClient, UpdateEndpointCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import * // const { PinpointClient, UpdateEndpointCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import * // import type { PinpointClientConfig } from "@aws-sdk/client-pinpoint"; * const config = {}; // type is PinpointClientConfig * const client = new PinpointClient(config); * const input = { // UpdateEndpointRequest * ApplicationId: "STRING_VALUE", // required * EndpointId: "STRING_VALUE", // required * EndpointRequest: { // EndpointRequest * Address: "STRING_VALUE", * Attributes: { // MapOfListOf__string * "": [ // ListOf__string * "STRING_VALUE", * ], * }, * ChannelType: "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP", * Demographic: { // EndpointDemographic * AppVersion: "STRING_VALUE", * Locale: "STRING_VALUE", * Make: "STRING_VALUE", * Model: "STRING_VALUE", * ModelVersion: "STRING_VALUE", * Platform: "STRING_VALUE", * PlatformVersion: "STRING_VALUE", * Timezone: "STRING_VALUE", * }, * EffectiveDate: "STRING_VALUE", * EndpointStatus: "STRING_VALUE", * Location: { // EndpointLocation * City: "STRING_VALUE", * Country: "STRING_VALUE", * Latitude: Number("double"), * Longitude: Number("double"), * PostalCode: "STRING_VALUE", * Region: "STRING_VALUE", * }, * Metrics: { // MapOf__double * "": Number("double"), * }, * OptOut: "STRING_VALUE", * RequestId: "STRING_VALUE", * User: { // EndpointUser * UserAttributes: { * "": [ * "STRING_VALUE", * ], * }, * UserId: "STRING_VALUE", * }, * }, * }; * const command = new UpdateEndpointCommand(input); * const response = await client.send(command); * // { // UpdateEndpointResponse * // MessageBody: { // MessageBody * // Message: "STRING_VALUE", * // RequestID: "STRING_VALUE", * // }, * // }; * * ``` * * @param UpdateEndpointCommandInput - {@link UpdateEndpointCommandInput} * @returns {@link UpdateEndpointCommandOutput} * @see {@link UpdateEndpointCommandInput} for command's `input` shape. * @see {@link UpdateEndpointCommandOutput} for command's `response` shape. * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape. * * @throws {@link BadRequestException} (client fault) *

Provides information about an API request or response.

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

Provides information about an API request or response.

* * @throws {@link InternalServerErrorException} (server fault) *

Provides information about an API request or response.

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

Provides information about an API request or response.

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

Provides information about an API request or response.

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

Provides information about an API request or response.

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

Provides information about an API request or response.

* * @throws {@link PinpointServiceException} *

Base exception class for all service exceptions from Pinpoint service.

* * * @public */ export declare class UpdateEndpointCommand extends UpdateEndpointCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateEndpointRequest; output: UpdateEndpointResponse; }; sdk: { input: UpdateEndpointCommandInput; output: UpdateEndpointCommandOutput; }; }; }