import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetJourneyRequest } from "../models/models_0"; import type { GetJourneyResponse } from "../models/models_1"; import type { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetJourneyCommand}. */ export interface GetJourneyCommandInput extends GetJourneyRequest { } /** * @public * * The output of {@link GetJourneyCommand}. */ export interface GetJourneyCommandOutput extends GetJourneyResponse, __MetadataBearer { } declare const GetJourneyCommand_base: { new (input: GetJourneyCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetJourneyCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Retrieves information about the status, configuration, and other settings for a journey.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { PinpointClient, GetJourneyCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import * // const { PinpointClient, GetJourneyCommand } = 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 = { // GetJourneyRequest * ApplicationId: "STRING_VALUE", // required * JourneyId: "STRING_VALUE", // required * }; * const command = new GetJourneyCommand(input); * const response = await client.send(command); * // { // GetJourneyResponse * // JourneyResponse: { // JourneyResponse * // Activities: { // MapOfActivity * // "": { // Activity * // CUSTOM: { // CustomMessageActivity * // DeliveryUri: "STRING_VALUE", * // EndpointTypes: [ // ListOf__EndpointTypesElement * // "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP", * // ], * // MessageConfig: { // JourneyCustomMessage * // Data: "STRING_VALUE", * // }, * // NextActivity: "STRING_VALUE", * // TemplateName: "STRING_VALUE", * // TemplateVersion: "STRING_VALUE", * // }, * // ConditionalSplit: { // ConditionalSplitActivity * // Condition: { // Condition * // Conditions: [ // ListOfSimpleCondition * // { // SimpleCondition * // EventCondition: { // EventCondition * // 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 * // }, * // }, * // }, * // MessageActivity: "STRING_VALUE", * // }, * // SegmentCondition: { // SegmentCondition * // SegmentId: "STRING_VALUE", // required * // }, * // SegmentDimensions: { // SegmentDimensions * // Attributes: { * // "": { * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // }, * // Behavior: { // SegmentBehaviors * // Recency: { // RecencyDimension * // Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required * // RecencyType: "ACTIVE" || "INACTIVE", // required * // }, * // }, * // Demographic: { // SegmentDemographics * // AppVersion: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // Channel: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // DeviceType: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", * // Values: "", // required * // }, * // Make: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", * // Values: "", // required * // }, * // Model: "", * // Platform: "", * // }, * // Location: { // SegmentLocation * // Country: "", * // GPSPoint: { // GPSPointDimension * // Coordinates: { // GPSCoordinates * // Latitude: Number("double"), // required * // Longitude: Number("double"), // required * // }, * // RangeInKilometers: Number("double"), * // }, * // }, * // Metrics: { * // "": { * // ComparisonOperator: "STRING_VALUE", // required * // Value: Number("double"), // required * // }, * // }, * // UserAttributes: { * // "": { * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * // Values: "", // required * // }, * // }, * // }, * // }, * // ], * // Operator: "ALL" || "ANY", * // }, * // EvaluationWaitTime: { // WaitTime * // WaitFor: "STRING_VALUE", * // WaitUntil: "STRING_VALUE", * // }, * // FalseActivity: "STRING_VALUE", * // TrueActivity: "STRING_VALUE", * // }, * // Description: "STRING_VALUE", * // EMAIL: { // EmailMessageActivity * // MessageConfig: { // JourneyEmailMessage * // FromAddress: "STRING_VALUE", * // }, * // NextActivity: "STRING_VALUE", * // TemplateName: "STRING_VALUE", * // TemplateVersion: "STRING_VALUE", * // }, * // Holdout: { // HoldoutActivity * // NextActivity: "STRING_VALUE", * // Percentage: Number("int"), // required * // }, * // MultiCondition: { // MultiConditionalSplitActivity * // Branches: [ // ListOfMultiConditionalBranch * // { // MultiConditionalBranch * // Condition: { * // EventCondition: { * // Dimensions: { * // Attributes: { * // "": { * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * // Values: "", // required * // }, * // }, * // EventType: "", * // Metrics: { * // "": { * // ComparisonOperator: "STRING_VALUE", // required * // Value: Number("double"), // required * // }, * // }, * // }, * // MessageActivity: "STRING_VALUE", * // }, * // SegmentCondition: { * // SegmentId: "STRING_VALUE", // required * // }, * // SegmentDimensions: { * // Attributes: { * // "": { * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * // Values: "", // required * // }, * // }, * // Behavior: { * // Recency: { * // Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required * // RecencyType: "ACTIVE" || "INACTIVE", // required * // }, * // }, * // Demographic: { * // AppVersion: "", * // Channel: "", * // DeviceType: "", * // Make: "", * // Model: "", * // Platform: "", * // }, * // Location: { * // Country: "", * // GPSPoint: { * // Coordinates: { * // Latitude: Number("double"), // required * // Longitude: Number("double"), // required * // }, * // RangeInKilometers: Number("double"), * // }, * // }, * // Metrics: { * // "": { * // ComparisonOperator: "STRING_VALUE", // required * // Value: Number("double"), // required * // }, * // }, * // UserAttributes: "", * // }, * // }, * // NextActivity: "STRING_VALUE", * // }, * // ], * // DefaultActivity: "STRING_VALUE", * // EvaluationWaitTime: { * // WaitFor: "STRING_VALUE", * // WaitUntil: "STRING_VALUE", * // }, * // }, * // PUSH: { // PushMessageActivity * // MessageConfig: { // JourneyPushMessage * // TimeToLive: "STRING_VALUE", * // }, * // NextActivity: "STRING_VALUE", * // TemplateName: "STRING_VALUE", * // TemplateVersion: "STRING_VALUE", * // }, * // RandomSplit: { // RandomSplitActivity * // Branches: [ // ListOfRandomSplitEntry * // { // RandomSplitEntry * // NextActivity: "STRING_VALUE", * // Percentage: Number("int"), * // }, * // ], * // }, * // SMS: { // SMSMessageActivity * // MessageConfig: { // JourneySMSMessage * // MessageType: "TRANSACTIONAL" || "PROMOTIONAL", * // OriginationNumber: "STRING_VALUE", * // SenderId: "STRING_VALUE", * // EntityId: "STRING_VALUE", * // TemplateId: "STRING_VALUE", * // }, * // NextActivity: "STRING_VALUE", * // TemplateName: "STRING_VALUE", * // TemplateVersion: "STRING_VALUE", * // }, * // Wait: { // WaitActivity * // NextActivity: "STRING_VALUE", * // WaitTime: { * // WaitFor: "STRING_VALUE", * // WaitUntil: "STRING_VALUE", * // }, * // }, * // ContactCenter: { // ContactCenterActivity * // NextActivity: "STRING_VALUE", * // }, * // }, * // }, * // ApplicationId: "STRING_VALUE", // required * // CreationDate: "STRING_VALUE", * // Id: "STRING_VALUE", // required * // LastModifiedDate: "STRING_VALUE", * // Limits: { // JourneyLimits * // DailyCap: Number("int"), * // EndpointReentryCap: Number("int"), * // MessagesPerSecond: Number("int"), * // EndpointReentryInterval: "STRING_VALUE", * // TimeframeCap: { // JourneyTimeframeCap * // Cap: Number("int"), * // Days: Number("int"), * // }, * // TotalCap: Number("int"), * // }, * // LocalTime: true || false, * // Name: "STRING_VALUE", // required * // QuietTime: { // QuietTime * // End: "STRING_VALUE", * // Start: "STRING_VALUE", * // }, * // RefreshFrequency: "STRING_VALUE", * // Schedule: { // JourneySchedule * // EndTime: new Date("TIMESTAMP"), * // StartTime: new Date("TIMESTAMP"), * // Timezone: "STRING_VALUE", * // }, * // StartActivity: "STRING_VALUE", * // StartCondition: { // StartCondition * // Description: "STRING_VALUE", * // EventStartCondition: { // EventStartCondition * // EventFilter: { // EventFilter * // Dimensions: { * // Attributes: "", * // EventType: "", * // Metrics: "", * // }, * // FilterType: "SYSTEM" || "ENDPOINT", // required * // }, * // SegmentId: "STRING_VALUE", * // }, * // SegmentStartCondition: { * // SegmentId: "STRING_VALUE", // required * // }, * // }, * // State: "DRAFT" || "ACTIVE" || "COMPLETED" || "CANCELLED" || "CLOSED" || "PAUSED", * // tags: { // MapOf__string * // "": "STRING_VALUE", * // }, * // WaitForQuietTime: true || false, * // RefreshOnSegmentUpdate: true || false, * // JourneyChannelSettings: { // JourneyChannelSettings * // ConnectCampaignArn: "STRING_VALUE", * // ConnectCampaignExecutionRoleArn: "STRING_VALUE", * // }, * // SendingSchedule: true || false, * // OpenHours: { // OpenHours * // EMAIL: { // MapOfListOfOpenHoursRules * // "": [ // ListOfOpenHoursRules * // { // OpenHoursRule * // StartTime: "STRING_VALUE", * // EndTime: "STRING_VALUE", * // }, * // ], * // }, * // SMS: { * // "": [ * // { * // StartTime: "STRING_VALUE", * // EndTime: "STRING_VALUE", * // }, * // ], * // }, * // PUSH: { * // "": [ * // { * // StartTime: "STRING_VALUE", * // EndTime: "STRING_VALUE", * // }, * // ], * // }, * // VOICE: { * // "": [ * // { * // StartTime: "STRING_VALUE", * // EndTime: "STRING_VALUE", * // }, * // ], * // }, * // CUSTOM: { * // "": [ * // { * // StartTime: "STRING_VALUE", * // EndTime: "STRING_VALUE", * // }, * // ], * // }, * // }, * // ClosedDays: { // ClosedDays * // EMAIL: [ // ListOfClosedDaysRules * // { // ClosedDaysRule * // Name: "STRING_VALUE", * // StartDateTime: "STRING_VALUE", * // EndDateTime: "STRING_VALUE", * // }, * // ], * // SMS: [ * // { * // Name: "STRING_VALUE", * // StartDateTime: "STRING_VALUE", * // EndDateTime: "STRING_VALUE", * // }, * // ], * // PUSH: [ * // { * // Name: "STRING_VALUE", * // StartDateTime: "STRING_VALUE", * // EndDateTime: "STRING_VALUE", * // }, * // ], * // VOICE: [ * // { * // Name: "STRING_VALUE", * // StartDateTime: "STRING_VALUE", * // EndDateTime: "STRING_VALUE", * // }, * // ], * // CUSTOM: [ * // { * // Name: "STRING_VALUE", * // StartDateTime: "STRING_VALUE", * // EndDateTime: "STRING_VALUE", * // }, * // ], * // }, * // TimezoneEstimationMethods: [ // ListOf__TimezoneEstimationMethodsElement * // "PHONE_NUMBER" || "POSTAL_CODE", * // ], * // }, * // }; * * ``` * * @param GetJourneyCommandInput - {@link GetJourneyCommandInput} * @returns {@link GetJourneyCommandOutput} * @see {@link GetJourneyCommandInput} for command's `input` shape. * @see {@link GetJourneyCommandOutput} 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 GetJourneyCommand extends GetJourneyCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetJourneyRequest; output: GetJourneyResponse; }; sdk: { input: GetJourneyCommandInput; output: GetJourneyCommandOutput; }; }; }