@aws-sdk/client-pinpoint 3.332.0 → 3.335.1

package/dist-types/ts3.4/commands/GetSegmentImportJobsCommand.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 {
-  GetSegmentImportJobsRequest,
-  GetSegmentImportJobsResponse,
-} from "../models/models_1";
-import {
-  PinpointClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../PinpointClient";
-export interface GetSegmentImportJobsCommandInput
-  extends GetSegmentImportJobsRequest {}
-export interface GetSegmentImportJobsCommandOutput
-  extends GetSegmentImportJobsResponse,
-    __MetadataBearer {}
-export declare class GetSegmentImportJobsCommand extends $Command<
-  GetSegmentImportJobsCommandInput,
-  GetSegmentImportJobsCommandOutput,
-  PinpointClientResolvedConfig
-> {
-  readonly input: GetSegmentImportJobsCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: GetSegmentImportJobsCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PinpointClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<
-    GetSegmentImportJobsCommandInput,
-    GetSegmentImportJobsCommandOutput
-  >;
-  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 { GetSegmentImportJobsRequest, GetSegmentImportJobsResponse } from "../models/models_1";
+import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
+/**
+ * @public
+ *
+ * The input for {@link GetSegmentImportJobsCommand}.
+ */
+export interface GetSegmentImportJobsCommandInput extends GetSegmentImportJobsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetSegmentImportJobsCommand}.
+ */
+export interface GetSegmentImportJobsCommandOutput extends GetSegmentImportJobsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieves information about the status and settings of the import jobs for a segment.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PinpointClient, GetSegmentImportJobsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
+ * // const { PinpointClient, GetSegmentImportJobsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
+ * const client = new PinpointClient(config);
+ * const input = { // GetSegmentImportJobsRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   PageSize: "STRING_VALUE",
+ *   SegmentId: "STRING_VALUE", // required
+ *   Token: "STRING_VALUE",
+ * };
+ * const command = new GetSegmentImportJobsCommand(input);
+ * const response = await client.send(command);
+ * // { // GetSegmentImportJobsResponse
+ * //   ImportJobsResponse: { // ImportJobsResponse
+ * //     Item: [ // ListOfImportJobResponse // required
+ * //       { // ImportJobResponse
+ * //         ApplicationId: "STRING_VALUE", // required
+ * //         CompletedPieces: Number("int"),
+ * //         CompletionDate: "STRING_VALUE",
+ * //         CreationDate: "STRING_VALUE", // required
+ * //         Definition: { // ImportJobResource
+ * //           DefineSegment: true || false,
+ * //           ExternalId: "STRING_VALUE",
+ * //           Format: "CSV" || "JSON", // required
+ * //           RegisterEndpoints: true || false,
+ * //           RoleArn: "STRING_VALUE", // required
+ * //           S3Url: "STRING_VALUE", // required
+ * //           SegmentId: "STRING_VALUE",
+ * //           SegmentName: "STRING_VALUE",
+ * //         },
+ * //         FailedPieces: Number("int"),
+ * //         Failures: [ // ListOf__string
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Id: "STRING_VALUE", // required
+ * //         JobStatus: "CREATED" || "PREPARING_FOR_INITIALIZATION" || "INITIALIZING" || "PROCESSING" || "PENDING_JOB" || "COMPLETING" || "COMPLETED" || "FAILING" || "FAILED", // required
+ * //         TotalFailures: Number("int"),
+ * //         TotalPieces: Number("int"),
+ * //         TotalProcessed: Number("int"),
+ * //         Type: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     NextToken: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetSegmentImportJobsCommandInput - {@link GetSegmentImportJobsCommandInput}
+ * @returns {@link GetSegmentImportJobsCommandOutput}
+ * @see {@link GetSegmentImportJobsCommandInput} for command's `input` shape.
+ * @see {@link GetSegmentImportJobsCommandOutput} 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 GetSegmentImportJobsCommand extends $Command<GetSegmentImportJobsCommandInput, GetSegmentImportJobsCommandOutput, PinpointClientResolvedConfig> {
+    readonly input: GetSegmentImportJobsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetSegmentImportJobsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSegmentImportJobsCommandInput, GetSegmentImportJobsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,38 +1,244 @@
-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 {
-  GetSegmentVersionRequest,
-  GetSegmentVersionResponse,
-} from "../models/models_1";
-import {
-  PinpointClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../PinpointClient";
-export interface GetSegmentVersionCommandInput
-  extends GetSegmentVersionRequest {}
-export interface GetSegmentVersionCommandOutput
-  extends GetSegmentVersionResponse,
-    __MetadataBearer {}
-export declare class GetSegmentVersionCommand extends $Command<
-  GetSegmentVersionCommandInput,
-  GetSegmentVersionCommandOutput,
-  PinpointClientResolvedConfig
-> {
-  readonly input: GetSegmentVersionCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: GetSegmentVersionCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PinpointClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<GetSegmentVersionCommandInput, GetSegmentVersionCommandOutput>;
-  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 { GetSegmentVersionRequest, GetSegmentVersionResponse } from "../models/models_1";
+import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
+/**
+ * @public
+ *
+ * The input for {@link GetSegmentVersionCommand}.
+ */
+export interface GetSegmentVersionCommandInput extends GetSegmentVersionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetSegmentVersionCommand}.
+ */
+export interface GetSegmentVersionCommandOutput extends GetSegmentVersionResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PinpointClient, GetSegmentVersionCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
+ * // const { PinpointClient, GetSegmentVersionCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
+ * const client = new PinpointClient(config);
+ * const input = { // GetSegmentVersionRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   SegmentId: "STRING_VALUE", // required
+ *   Version: "STRING_VALUE", // required
+ * };
+ * const command = new GetSegmentVersionCommand(input);
+ * const response = await client.send(command);
+ * // { // GetSegmentVersionResponse
+ * //   SegmentResponse: { // SegmentResponse
+ * //     ApplicationId: "STRING_VALUE", // required
+ * //     Arn: "STRING_VALUE", // required
+ * //     CreationDate: "STRING_VALUE", // required
+ * //     Dimensions: { // SegmentDimensions
+ * //       Attributes: { // MapOfAttributeDimension
+ * //         "<keys>": { // AttributeDimension
+ * //           AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
+ * //           Values: [ // ListOf__string // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //       },
+ * //       Behavior: { // SegmentBehaviors
+ * //         Recency: { // RecencyDimension
+ * //           Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
+ * //           RecencyType: "ACTIVE" || "INACTIVE", // required
+ * //         },
+ * //       },
+ * //       Demographic: { // SegmentDemographics
+ * //         AppVersion: { // SetDimension
+ * //           DimensionType: "INCLUSIVE" || "EXCLUSIVE",
+ * //           Values: [ // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //         Channel: {
+ * //           DimensionType: "INCLUSIVE" || "EXCLUSIVE",
+ * //           Values: [ // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //         DeviceType: {
+ * //           DimensionType: "INCLUSIVE" || "EXCLUSIVE",
+ * //           Values: [ // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //         Make: {
+ * //           DimensionType: "INCLUSIVE" || "EXCLUSIVE",
+ * //           Values: [ // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //         Model: {
+ * //           DimensionType: "INCLUSIVE" || "EXCLUSIVE",
+ * //           Values: "<ListOf__string>", // required
+ * //         },
+ * //         Platform: "<SetDimension>",
+ * //       },
+ * //       Location: { // SegmentLocation
+ * //         Country: "<SetDimension>",
+ * //         GPSPoint: { // GPSPointDimension
+ * //           Coordinates: { // GPSCoordinates
+ * //             Latitude: Number("double"), // required
+ * //             Longitude: Number("double"), // required
+ * //           },
+ * //           RangeInKilometers: Number("double"),
+ * //         },
+ * //       },
+ * //       Metrics: { // MapOfMetricDimension
+ * //         "<keys>": { // MetricDimension
+ * //           ComparisonOperator: "STRING_VALUE", // required
+ * //           Value: Number("double"), // required
+ * //         },
+ * //       },
+ * //       UserAttributes: {
+ * //         "<keys>": {
+ * //           AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
+ * //           Values: "<ListOf__string>", // required
+ * //         },
+ * //       },
+ * //     },
+ * //     Id: "STRING_VALUE", // required
+ * //     ImportDefinition: { // SegmentImportResource
+ * //       ChannelCounts: { // MapOf__integer
+ * //         "<keys>": Number("int"),
+ * //       },
+ * //       ExternalId: "STRING_VALUE", // required
+ * //       Format: "CSV" || "JSON", // required
+ * //       RoleArn: "STRING_VALUE", // required
+ * //       S3Url: "STRING_VALUE", // required
+ * //       Size: Number("int"), // required
+ * //     },
+ * //     LastModifiedDate: "STRING_VALUE",
+ * //     Name: "STRING_VALUE",
+ * //     SegmentGroups: { // SegmentGroupList
+ * //       Groups: [ // ListOfSegmentGroup
+ * //         { // SegmentGroup
+ * //           Dimensions: [ // ListOfSegmentDimensions
+ * //             {
+ * //               Attributes: {
+ * //                 "<keys>": {
+ * //                   AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
+ * //                   Values: "<ListOf__string>", // required
+ * //                 },
+ * //               },
+ * //               Behavior: {
+ * //                 Recency: {
+ * //                   Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required
+ * //                   RecencyType: "ACTIVE" || "INACTIVE", // required
+ * //                 },
+ * //               },
+ * //               Demographic: {
+ * //                 AppVersion: "<SetDimension>",
+ * //                 Channel: "<SetDimension>",
+ * //                 DeviceType: "<SetDimension>",
+ * //                 Make: "<SetDimension>",
+ * //                 Model: "<SetDimension>",
+ * //                 Platform: "<SetDimension>",
+ * //               },
+ * //               Location: {
+ * //                 Country: "<SetDimension>",
+ * //                 GPSPoint: {
+ * //                   Coordinates: {
+ * //                     Latitude: Number("double"), // required
+ * //                     Longitude: Number("double"), // required
+ * //                   },
+ * //                   RangeInKilometers: Number("double"),
+ * //                 },
+ * //               },
+ * //               Metrics: {
+ * //                 "<keys>": {
+ * //                   ComparisonOperator: "STRING_VALUE", // required
+ * //                   Value: Number("double"), // required
+ * //                 },
+ * //               },
+ * //               UserAttributes: {
+ * //                 "<keys>": {
+ * //                   AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
+ * //                   Values: "<ListOf__string>", // required
+ * //                 },
+ * //               },
+ * //             },
+ * //           ],
+ * //           SourceSegments: [ // ListOfSegmentReference
+ * //             { // SegmentReference
+ * //               Id: "STRING_VALUE", // required
+ * //               Version: Number("int"),
+ * //             },
+ * //           ],
+ * //           SourceType: "ALL" || "ANY" || "NONE",
+ * //           Type: "ALL" || "ANY" || "NONE",
+ * //         },
+ * //       ],
+ * //       Include: "ALL" || "ANY" || "NONE",
+ * //     },
+ * //     SegmentType: "DIMENSIONAL" || "IMPORT", // required
+ * //     tags: { // MapOf__string
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     Version: Number("int"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetSegmentVersionCommandInput - {@link GetSegmentVersionCommandInput}
+ * @returns {@link GetSegmentVersionCommandOutput}
+ * @see {@link GetSegmentVersionCommandInput} for command's `input` shape.
+ * @see {@link GetSegmentVersionCommandOutput} 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 GetSegmentVersionCommand extends $Command<GetSegmentVersionCommandInput, GetSegmentVersionCommandOutput, PinpointClientResolvedConfig> {
+    readonly input: GetSegmentVersionCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetSegmentVersionCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSegmentVersionCommandInput, GetSegmentVersionCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}