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

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { PinpointClient, GetCampaignsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import * // const { PinpointClient, GetCampaignsCommand } = 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 = { // GetCampaignsRequest * ApplicationId: "STRING_VALUE", // required * PageSize: "STRING_VALUE", * Token: "STRING_VALUE", * }; * const command = new GetCampaignsCommand(input); * const response = await client.send(command); * // { // GetCampaignsResponse * // CampaignsResponse: { // CampaignsResponse * // Item: [ // ListOfCampaignResponse // required * // { // CampaignResponse * // AdditionalTreatments: [ // ListOfTreatmentResource * // { // TreatmentResource * // CustomDeliveryConfiguration: { // CustomDeliveryConfiguration * // DeliveryUri: "STRING_VALUE", // required * // EndpointTypes: [ // ListOf__EndpointTypesElement * // "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP", * // ], * // }, * // Id: "STRING_VALUE", // required * // MessageConfiguration: { // MessageConfiguration * // ADMMessage: { // Message * // Action: "OPEN_APP" || "DEEP_LINK" || "URL", * // Body: "STRING_VALUE", * // ImageIconUrl: "STRING_VALUE", * // ImageSmallIconUrl: "STRING_VALUE", * // ImageUrl: "STRING_VALUE", * // JsonBody: "STRING_VALUE", * // MediaUrl: "STRING_VALUE", * // RawContent: "STRING_VALUE", * // SilentPush: true || false, * // TimeToLive: Number("int"), * // Title: "STRING_VALUE", * // Url: "STRING_VALUE", * // }, * // APNSMessage: { * // Action: "OPEN_APP" || "DEEP_LINK" || "URL", * // Body: "STRING_VALUE", * // ImageIconUrl: "STRING_VALUE", * // ImageSmallIconUrl: "STRING_VALUE", * // ImageUrl: "STRING_VALUE", * // JsonBody: "STRING_VALUE", * // MediaUrl: "STRING_VALUE", * // RawContent: "STRING_VALUE", * // SilentPush: true || false, * // TimeToLive: Number("int"), * // Title: "STRING_VALUE", * // Url: "STRING_VALUE", * // }, * // BaiduMessage: { * // Action: "OPEN_APP" || "DEEP_LINK" || "URL", * // Body: "STRING_VALUE", * // ImageIconUrl: "STRING_VALUE", * // ImageSmallIconUrl: "STRING_VALUE", * // ImageUrl: "STRING_VALUE", * // JsonBody: "STRING_VALUE", * // MediaUrl: "STRING_VALUE", * // RawContent: "STRING_VALUE", * // SilentPush: true || false, * // TimeToLive: Number("int"), * // Title: "STRING_VALUE", * // Url: "STRING_VALUE", * // }, * // CustomMessage: { // CampaignCustomMessage * // Data: "STRING_VALUE", * // }, * // DefaultMessage: { * // Action: "OPEN_APP" || "DEEP_LINK" || "URL", * // Body: "STRING_VALUE", * // ImageIconUrl: "STRING_VALUE", * // ImageSmallIconUrl: "STRING_VALUE", * // ImageUrl: "STRING_VALUE", * // JsonBody: "STRING_VALUE", * // MediaUrl: "STRING_VALUE", * // RawContent: "STRING_VALUE", * // SilentPush: true || false, * // TimeToLive: Number("int"), * // Title: "STRING_VALUE", * // Url: "STRING_VALUE", * // }, * // EmailMessage: { // CampaignEmailMessage * // Body: "STRING_VALUE", * // FromAddress: "STRING_VALUE", * // Headers: [ // ListOfMessageHeader * // { // MessageHeader * // Name: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // HtmlBody: "STRING_VALUE", * // Title: "STRING_VALUE", * // }, * // GCMMessage: { * // Action: "OPEN_APP" || "DEEP_LINK" || "URL", * // Body: "STRING_VALUE", * // ImageIconUrl: "STRING_VALUE", * // ImageSmallIconUrl: "STRING_VALUE", * // ImageUrl: "STRING_VALUE", * // JsonBody: "STRING_VALUE", * // MediaUrl: "STRING_VALUE", * // RawContent: "STRING_VALUE", * // SilentPush: true || false, * // TimeToLive: Number("int"), * // Title: "STRING_VALUE", * // Url: "STRING_VALUE", * // }, * // SMSMessage: { // CampaignSmsMessage * // Body: "STRING_VALUE", * // MessageType: "TRANSACTIONAL" || "PROMOTIONAL", * // OriginationNumber: "STRING_VALUE", * // SenderId: "STRING_VALUE", * // EntityId: "STRING_VALUE", * // TemplateId: "STRING_VALUE", * // }, * // InAppMessage: { // CampaignInAppMessage * // Body: "STRING_VALUE", * // 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", * // }, * // }, * // Schedule: { // Schedule * // EndTime: "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 * // }, * // Frequency: "ONCE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "EVENT" || "IN_APP_EVENT", * // IsLocalTime: true || false, * // QuietTime: { // QuietTime * // End: "STRING_VALUE", * // Start: "STRING_VALUE", * // }, * // StartTime: "STRING_VALUE", // required * // Timezone: "STRING_VALUE", * // }, * // SizePercent: Number("int"), // required * // State: { // CampaignState * // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID", * // }, * // TemplateConfiguration: { // TemplateConfiguration * // EmailTemplate: { // Template * // Name: "STRING_VALUE", * // Version: "STRING_VALUE", * // }, * // PushTemplate: { * // Name: "STRING_VALUE", * // Version: "STRING_VALUE", * // }, * // SMSTemplate: { * // Name: "STRING_VALUE", * // Version: "STRING_VALUE", * // }, * // VoiceTemplate: { * // Name: "STRING_VALUE", * // Version: "STRING_VALUE", * // }, * // InAppTemplate: { * // Name: "STRING_VALUE", * // Version: "STRING_VALUE", * // }, * // }, * // TreatmentDescription: "STRING_VALUE", * // TreatmentName: "STRING_VALUE", * // }, * // ], * // ApplicationId: "STRING_VALUE", // required * // Arn: "STRING_VALUE", // required * // CreationDate: "STRING_VALUE", // required * // CustomDeliveryConfiguration: { * // DeliveryUri: "STRING_VALUE", // required * // EndpointTypes: [ * // "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP", * // ], * // }, * // DefaultState: { * // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID", * // }, * // Description: "STRING_VALUE", * // HoldoutPercent: Number("int"), * // Hook: { // CampaignHook * // LambdaFunctionName: "STRING_VALUE", * // Mode: "DELIVERY" || "FILTER", * // WebUrl: "STRING_VALUE", * // }, * // Id: "STRING_VALUE", // required * // IsPaused: true || false, * // LastModifiedDate: "STRING_VALUE", // required * // Limits: { // CampaignLimits * // Daily: Number("int"), * // MaximumDuration: Number("int"), * // MessagesPerSecond: Number("int"), * // Total: Number("int"), * // Session: Number("int"), * // }, * // MessageConfiguration: { * // ADMMessage: "", * // APNSMessage: "", * // BaiduMessage: "", * // CustomMessage: { * // Data: "STRING_VALUE", * // }, * // DefaultMessage: "", * // EmailMessage: { * // Body: "STRING_VALUE", * // FromAddress: "STRING_VALUE", * // Headers: [ * // { * // Name: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // HtmlBody: "STRING_VALUE", * // Title: "STRING_VALUE", * // }, * // GCMMessage: "", * // SMSMessage: { * // Body: "STRING_VALUE", * // MessageType: "TRANSACTIONAL" || "PROMOTIONAL", * // OriginationNumber: "STRING_VALUE", * // SenderId: "STRING_VALUE", * // EntityId: "STRING_VALUE", * // TemplateId: "STRING_VALUE", * // }, * // InAppMessage: { * // Body: "STRING_VALUE", * // Content: [ * // { * // BackgroundColor: "STRING_VALUE", * // BodyConfig: { * // Alignment: "LEFT" || "CENTER" || "RIGHT", // required * // Body: "STRING_VALUE", // required * // TextColor: "STRING_VALUE", // required * // }, * // HeaderConfig: { * // Alignment: "LEFT" || "CENTER" || "RIGHT", // required * // Header: "STRING_VALUE", // required * // TextColor: "STRING_VALUE", // required * // }, * // ImageUrl: "STRING_VALUE", * // PrimaryBtn: { * // Android: "", * // DefaultConfig: { * // BackgroundColor: "STRING_VALUE", * // BorderRadius: Number("int"), * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required * // Link: "STRING_VALUE", * // Text: "STRING_VALUE", // required * // TextColor: "STRING_VALUE", * // }, * // IOS: "", * // Web: "", * // }, * // SecondaryBtn: { * // Android: "", * // DefaultConfig: { * // BackgroundColor: "STRING_VALUE", * // BorderRadius: Number("int"), * // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required * // Link: "STRING_VALUE", * // Text: "STRING_VALUE", // required * // TextColor: "STRING_VALUE", * // }, * // IOS: "", * // Web: "", * // }, * // }, * // ], * // CustomConfig: { * // "": "STRING_VALUE", * // }, * // Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL", * // }, * // }, * // Name: "STRING_VALUE", * // Schedule: { * // EndTime: "STRING_VALUE", * // EventFilter: { * // Dimensions: { * // Attributes: { * // "": { * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * // Values: "", // required * // }, * // }, * // EventType: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", * // Values: "", // required * // }, * // Metrics: { * // "": { * // ComparisonOperator: "STRING_VALUE", // required * // Value: Number("double"), // required * // }, * // }, * // }, * // FilterType: "SYSTEM" || "ENDPOINT", // required * // }, * // Frequency: "ONCE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "EVENT" || "IN_APP_EVENT", * // IsLocalTime: true || false, * // QuietTime: { * // End: "STRING_VALUE", * // Start: "STRING_VALUE", * // }, * // StartTime: "STRING_VALUE", // required * // Timezone: "STRING_VALUE", * // }, * // SegmentId: "STRING_VALUE", // required * // SegmentVersion: Number("int"), // required * // State: { * // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID", * // }, * // tags: "", * // TemplateConfiguration: { * // EmailTemplate: "