import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetInAppMessagesRequest, GetInAppMessagesResponse } from "../models/models_0"; import type { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetInAppMessagesCommand}. */ export interface GetInAppMessagesCommandInput extends GetInAppMessagesRequest { } /** * @public * * The output of {@link GetInAppMessagesCommand}. */ export interface GetInAppMessagesCommandOutput extends GetInAppMessagesResponse, __MetadataBearer { } declare const GetInAppMessagesCommand_base: { new (input: GetInAppMessagesCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetInAppMessagesCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Retrieves the in-app messages targeted for the provided endpoint ID.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { PinpointClient, GetInAppMessagesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import * // const { PinpointClient, GetInAppMessagesCommand } = 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 = { // GetInAppMessagesRequest * ApplicationId: "STRING_VALUE", // required * EndpointId: "STRING_VALUE", // required * }; * const command = new GetInAppMessagesCommand(input); * const response = await client.send(command); * // { // GetInAppMessagesResponse * // InAppMessagesResponse: { // InAppMessagesResponse * // InAppMessageCampaigns: [ // ListOfInAppMessageCampaign * // { // InAppMessageCampaign * // CampaignId: "STRING_VALUE", * // DailyCap: Number("int"), * // InAppMessage: { // InAppMessage * // Content: [ // ListOfInAppMessageContent * // { // InAppMessageContent * // BackgroundColor: "STRING_VALUE", * // BodyConfig: { // InAppMessageBodyConfig * // Alignment: "LEFT" || "CENTER" || "RIGHT", // required * // Body: "STRING_VALUE", // required * // TextColor: "STRING_VALUE", // required * // }, * // HeaderConfig: { // InAppMessageHeaderConfig * // Alignment: "LEFT" || "CENTER" || "RIGHT", // required * // Header: "STRING_VALUE", // required * // TextColor: "STRING_VALUE", // required * // }, * // ImageUrl: "STRING_VALUE", * // PrimaryBtn: { // InAppMessageButton * // Android: { // OverrideButtonConfiguration * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required * // Link: "STRING_VALUE", * // }, * // DefaultConfig: { // DefaultButtonConfiguration * // BackgroundColor: "STRING_VALUE", * // BorderRadius: Number("int"), * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required * // Link: "STRING_VALUE", * // Text: "STRING_VALUE", // required * // TextColor: "STRING_VALUE", * // }, * // IOS: { * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required * // Link: "STRING_VALUE", * // }, * // Web: { * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required * // Link: "STRING_VALUE", * // }, * // }, * // SecondaryBtn: { * // Android: { * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required * // Link: "STRING_VALUE", * // }, * // DefaultConfig: { * // BackgroundColor: "STRING_VALUE", * // BorderRadius: Number("int"), * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required * // Link: "STRING_VALUE", * // Text: "STRING_VALUE", // required * // TextColor: "STRING_VALUE", * // }, * // IOS: { * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required * // Link: "STRING_VALUE", * // }, * // Web: "", * // }, * // }, * // ], * // CustomConfig: { // MapOf__string * // "": "STRING_VALUE", * // }, * // Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL", * // }, * // Priority: Number("int"), * // Schedule: { // InAppCampaignSchedule * // EndDate: "STRING_VALUE", * // EventFilter: { // CampaignEventFilter * // Dimensions: { // EventDimensions * // Attributes: { // MapOfAttributeDimension * // "": { // AttributeDimension * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * // Values: [ // ListOf__string // required * // "STRING_VALUE", * // ], * // }, * // }, * // EventType: { // SetDimension * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // Metrics: { // MapOfMetricDimension * // "": { // MetricDimension * // ComparisonOperator: "STRING_VALUE", // required * // Value: Number("double"), // required * // }, * // }, * // }, * // FilterType: "SYSTEM" || "ENDPOINT", // required * // }, * // QuietTime: { // QuietTime * // End: "STRING_VALUE", * // Start: "STRING_VALUE", * // }, * // }, * // SessionCap: Number("int"), * // TotalCap: Number("int"), * // TreatmentId: "STRING_VALUE", * // }, * // ], * // }, * // }; * * ``` * * @param GetInAppMessagesCommandInput - {@link GetInAppMessagesCommandInput} * @returns {@link GetInAppMessagesCommandOutput} * @see {@link GetInAppMessagesCommandInput} for command's `input` shape. * @see {@link GetInAppMessagesCommandOutput} 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 GetInAppMessagesCommand extends GetInAppMessagesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetInAppMessagesRequest; output: GetInAppMessagesResponse; }; sdk: { input: GetInAppMessagesCommandInput; output: GetInAppMessagesCommandOutput; }; }; }