@aws-sdk/client-pinpoint 3.335.0 → 3.335.1

package/dist-types/ts3.4/commands/GetCampaignDateRangeKpiCommand.d.ts

@@ -1,41 +1,123 @@
-import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
-import { Command as $Command } from "@aws-sdk/smithy-client";
-import {
-  Handler,
-  HttpHandlerOptions as __HttpHandlerOptions,
-  MetadataBearer as __MetadataBearer,
-  MiddlewareStack,
-} from "@aws-sdk/types";
-import {
-  GetCampaignDateRangeKpiRequest,
-  GetCampaignDateRangeKpiResponse,
-} from "../models/models_0";
-import {
-  PinpointClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../PinpointClient";
-export interface GetCampaignDateRangeKpiCommandInput
-  extends GetCampaignDateRangeKpiRequest {}
-export interface GetCampaignDateRangeKpiCommandOutput
-  extends GetCampaignDateRangeKpiResponse,
-    __MetadataBearer {}
-export declare class GetCampaignDateRangeKpiCommand extends $Command<
-  GetCampaignDateRangeKpiCommandInput,
-  GetCampaignDateRangeKpiCommandOutput,
-  PinpointClientResolvedConfig
-> {
-  readonly input: GetCampaignDateRangeKpiCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: GetCampaignDateRangeKpiCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PinpointClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<
-    GetCampaignDateRangeKpiCommandInput,
-    GetCampaignDateRangeKpiCommandOutput
-  >;
-  private serialize;
-  private deserialize;
-}
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { GetCampaignDateRangeKpiRequest, GetCampaignDateRangeKpiResponse } from "../models/models_0";
+import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
+/**
+ * @public
+ *
+ * The input for {@link GetCampaignDateRangeKpiCommand}.
+ */
+export interface GetCampaignDateRangeKpiCommandInput extends GetCampaignDateRangeKpiRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetCampaignDateRangeKpiCommand}.
+ */
+export interface GetCampaignDateRangeKpiCommandOutput extends GetCampaignDateRangeKpiResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PinpointClient, GetCampaignDateRangeKpiCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
+ * // const { PinpointClient, GetCampaignDateRangeKpiCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
+ * const client = new PinpointClient(config);
+ * const input = { // GetCampaignDateRangeKpiRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   CampaignId: "STRING_VALUE", // required
+ *   EndTime: new Date("TIMESTAMP"),
+ *   KpiName: "STRING_VALUE", // required
+ *   NextToken: "STRING_VALUE",
+ *   PageSize: "STRING_VALUE",
+ *   StartTime: new Date("TIMESTAMP"),
+ * };
+ * const command = new GetCampaignDateRangeKpiCommand(input);
+ * const response = await client.send(command);
+ * // { // GetCampaignDateRangeKpiResponse
+ * //   CampaignDateRangeKpiResponse: { // CampaignDateRangeKpiResponse
+ * //     ApplicationId: "STRING_VALUE", // required
+ * //     CampaignId: "STRING_VALUE", // required
+ * //     EndTime: new Date("TIMESTAMP"), // required
+ * //     KpiName: "STRING_VALUE", // required
+ * //     KpiResult: { // BaseKpiResult
+ * //       Rows: [ // ListOfResultRow // required
+ * //         { // ResultRow
+ * //           GroupedBys: [ // ListOfResultRowValue // required
+ * //             { // ResultRowValue
+ * //               Key: "STRING_VALUE", // required
+ * //               Type: "STRING_VALUE", // required
+ * //               Value: "STRING_VALUE", // required
+ * //             },
+ * //           ],
+ * //           Values: [ // required
+ * //             {
+ * //               Key: "STRING_VALUE", // required
+ * //               Type: "STRING_VALUE", // required
+ * //               Value: "STRING_VALUE", // required
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //     },
+ * //     NextToken: "STRING_VALUE",
+ * //     StartTime: new Date("TIMESTAMP"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetCampaignDateRangeKpiCommandInput - {@link GetCampaignDateRangeKpiCommandInput}
+ * @returns {@link GetCampaignDateRangeKpiCommandOutput}
+ * @see {@link GetCampaignDateRangeKpiCommandInput} for command's `input` shape.
+ * @see {@link GetCampaignDateRangeKpiCommandOutput} for command's `response` shape.
+ * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link InternalServerErrorException} (server fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link MethodNotAllowedException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link PayloadTooLargeException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>Provides information about an API request or response.</p>
+ *
+ * @throws {@link PinpointServiceException}
+ * <p>Base exception class for all service exceptions from Pinpoint service.</p>
+ *
+ */
+export declare class GetCampaignDateRangeKpiCommand extends $Command<GetCampaignDateRangeKpiCommandInput, GetCampaignDateRangeKpiCommandOutput, PinpointClientResolvedConfig> {
+    readonly input: GetCampaignDateRangeKpiCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetCampaignDateRangeKpiCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCampaignDateRangeKpiCommandInput, GetCampaignDateRangeKpiCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}