@aws-sdk/client-pinpoint 3.335.0 → 3.335.1

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

@@ -1,37 +1,101 @@
-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 {
-  PutEventStreamRequest,
-  PutEventStreamResponse,
-} from "../models/models_1";
-import {
-  PinpointClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../PinpointClient";
-export interface PutEventStreamCommandInput extends PutEventStreamRequest {}
-export interface PutEventStreamCommandOutput
-  extends PutEventStreamResponse,
-    __MetadataBearer {}
-export declare class PutEventStreamCommand extends $Command<
-  PutEventStreamCommandInput,
-  PutEventStreamCommandOutput,
-  PinpointClientResolvedConfig
-> {
-  readonly input: PutEventStreamCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: PutEventStreamCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PinpointClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<PutEventStreamCommandInput, PutEventStreamCommandOutput>;
-  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 { PutEventStreamRequest, PutEventStreamResponse } from "../models/models_1";
+import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
+/**
+ * @public
+ *
+ * The input for {@link PutEventStreamCommand}.
+ */
+export interface PutEventStreamCommandInput extends PutEventStreamRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutEventStreamCommand}.
+ */
+export interface PutEventStreamCommandOutput extends PutEventStreamResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Creates a new event stream for an application or updates the settings of an existing event stream for an application.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PinpointClient, PutEventStreamCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
+ * // const { PinpointClient, PutEventStreamCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
+ * const client = new PinpointClient(config);
+ * const input = { // PutEventStreamRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   WriteEventStream: { // WriteEventStream
+ *     DestinationStreamArn: "STRING_VALUE", // required
+ *     RoleArn: "STRING_VALUE", // required
+ *   },
+ * };
+ * const command = new PutEventStreamCommand(input);
+ * const response = await client.send(command);
+ * // { // PutEventStreamResponse
+ * //   EventStream: { // EventStream
+ * //     ApplicationId: "STRING_VALUE", // required
+ * //     DestinationStreamArn: "STRING_VALUE", // required
+ * //     ExternalId: "STRING_VALUE",
+ * //     LastModifiedDate: "STRING_VALUE",
+ * //     LastUpdatedBy: "STRING_VALUE",
+ * //     RoleArn: "STRING_VALUE", // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param PutEventStreamCommandInput - {@link PutEventStreamCommandInput}
+ * @returns {@link PutEventStreamCommandOutput}
+ * @see {@link PutEventStreamCommandInput} for command's `input` shape.
+ * @see {@link PutEventStreamCommandOutput} 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 PutEventStreamCommand extends $Command<PutEventStreamCommandInput, PutEventStreamCommandOutput, PinpointClientResolvedConfig> {
+    readonly input: PutEventStreamCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: PutEventStreamCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutEventStreamCommandInput, PutEventStreamCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,34 +1,176 @@
-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 { PutEventsRequest, PutEventsResponse } from "../models/models_1";
-import {
-  PinpointClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../PinpointClient";
-export interface PutEventsCommandInput extends PutEventsRequest {}
-export interface PutEventsCommandOutput
-  extends PutEventsResponse,
-    __MetadataBearer {}
-export declare class PutEventsCommand extends $Command<
-  PutEventsCommandInput,
-  PutEventsCommandOutput,
-  PinpointClientResolvedConfig
-> {
-  readonly input: PutEventsCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: PutEventsCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PinpointClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<PutEventsCommandInput, PutEventsCommandOutput>;
-  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 { PutEventsRequest, PutEventsResponse } from "../models/models_1";
+import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
+/**
+ * @public
+ *
+ * The input for {@link PutEventsCommand}.
+ */
+export interface PutEventsCommandInput extends PutEventsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutEventsCommand}.
+ */
+export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PinpointClient, PutEventsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
+ * // const { PinpointClient, PutEventsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
+ * const client = new PinpointClient(config);
+ * const input = { // PutEventsRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   EventsRequest: { // EventsRequest
+ *     BatchItem: { // MapOfEventsBatch // required
+ *       "<keys>": { // EventsBatch
+ *         Endpoint: { // PublicEndpoint
+ *           Address: "STRING_VALUE",
+ *           Attributes: { // MapOfListOf__string
+ *             "<keys>": [ // ListOf__string
+ *               "STRING_VALUE",
+ *             ],
+ *           },
+ *           ChannelType: "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
+ *           Demographic: { // EndpointDemographic
+ *             AppVersion: "STRING_VALUE",
+ *             Locale: "STRING_VALUE",
+ *             Make: "STRING_VALUE",
+ *             Model: "STRING_VALUE",
+ *             ModelVersion: "STRING_VALUE",
+ *             Platform: "STRING_VALUE",
+ *             PlatformVersion: "STRING_VALUE",
+ *             Timezone: "STRING_VALUE",
+ *           },
+ *           EffectiveDate: "STRING_VALUE",
+ *           EndpointStatus: "STRING_VALUE",
+ *           Location: { // EndpointLocation
+ *             City: "STRING_VALUE",
+ *             Country: "STRING_VALUE",
+ *             Latitude: Number("double"),
+ *             Longitude: Number("double"),
+ *             PostalCode: "STRING_VALUE",
+ *             Region: "STRING_VALUE",
+ *           },
+ *           Metrics: { // MapOf__double
+ *             "<keys>": Number("double"),
+ *           },
+ *           OptOut: "STRING_VALUE",
+ *           RequestId: "STRING_VALUE",
+ *           User: { // EndpointUser
+ *             UserAttributes: {
+ *               "<keys>": [
+ *                 "STRING_VALUE",
+ *               ],
+ *             },
+ *             UserId: "STRING_VALUE",
+ *           },
+ *         },
+ *         Events: { // MapOfEvent // required
+ *           "<keys>": { // Event
+ *             AppPackageName: "STRING_VALUE",
+ *             AppTitle: "STRING_VALUE",
+ *             AppVersionCode: "STRING_VALUE",
+ *             Attributes: { // MapOf__string
+ *               "<keys>": "STRING_VALUE",
+ *             },
+ *             ClientSdkVersion: "STRING_VALUE",
+ *             EventType: "STRING_VALUE", // required
+ *             Metrics: {
+ *               "<keys>": Number("double"),
+ *             },
+ *             SdkName: "STRING_VALUE",
+ *             Session: { // Session
+ *               Duration: Number("int"),
+ *               Id: "STRING_VALUE", // required
+ *               StartTimestamp: "STRING_VALUE", // required
+ *               StopTimestamp: "STRING_VALUE",
+ *             },
+ *             Timestamp: "STRING_VALUE", // required
+ *           },
+ *         },
+ *       },
+ *     },
+ *   },
+ * };
+ * const command = new PutEventsCommand(input);
+ * const response = await client.send(command);
+ * // { // PutEventsResponse
+ * //   EventsResponse: { // EventsResponse
+ * //     Results: { // MapOfItemResponse
+ * //       "<keys>": { // ItemResponse
+ * //         EndpointItemResponse: { // EndpointItemResponse
+ * //           Message: "STRING_VALUE",
+ * //           StatusCode: Number("int"),
+ * //         },
+ * //         EventsItemResponse: { // MapOfEventItemResponse
+ * //           "<keys>": { // EventItemResponse
+ * //             Message: "STRING_VALUE",
+ * //             StatusCode: Number("int"),
+ * //           },
+ * //         },
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param PutEventsCommandInput - {@link PutEventsCommandInput}
+ * @returns {@link PutEventsCommandOutput}
+ * @see {@link PutEventsCommandInput} for command's `input` shape.
+ * @see {@link PutEventsCommandOutput} 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 PutEventsCommand extends $Command<PutEventsCommandInput, PutEventsCommandOutput, PinpointClientResolvedConfig> {
+    readonly input: PutEventsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: PutEventsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutEventsCommandInput, PutEventsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,37 +1,102 @@
-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 {
-  RemoveAttributesRequest,
-  RemoveAttributesResponse,
-} from "../models/models_1";
-import {
-  PinpointClientResolvedConfig,
-  ServiceInputTypes,
-  ServiceOutputTypes,
-} from "../PinpointClient";
-export interface RemoveAttributesCommandInput extends RemoveAttributesRequest {}
-export interface RemoveAttributesCommandOutput
-  extends RemoveAttributesResponse,
-    __MetadataBearer {}
-export declare class RemoveAttributesCommand extends $Command<
-  RemoveAttributesCommandInput,
-  RemoveAttributesCommandOutput,
-  PinpointClientResolvedConfig
-> {
-  readonly input: RemoveAttributesCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: RemoveAttributesCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: PinpointClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<RemoveAttributesCommandInput, RemoveAttributesCommandOutput>;
-  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 { RemoveAttributesRequest, RemoveAttributesResponse } from "../models/models_1";
+import { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient";
+/**
+ * @public
+ *
+ * The input for {@link RemoveAttributesCommand}.
+ */
+export interface RemoveAttributesCommandInput extends RemoveAttributesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link RemoveAttributesCommand}.
+ */
+export interface RemoveAttributesCommandOutput extends RemoveAttributesResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PinpointClient, RemoveAttributesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
+ * // const { PinpointClient, RemoveAttributesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
+ * const client = new PinpointClient(config);
+ * const input = { // RemoveAttributesRequest
+ *   ApplicationId: "STRING_VALUE", // required
+ *   AttributeType: "STRING_VALUE", // required
+ *   UpdateAttributesRequest: { // UpdateAttributesRequest
+ *     Blacklist: [ // ListOf__string
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ * };
+ * const command = new RemoveAttributesCommand(input);
+ * const response = await client.send(command);
+ * // { // RemoveAttributesResponse
+ * //   AttributesResource: { // AttributesResource
+ * //     ApplicationId: "STRING_VALUE", // required
+ * //     AttributeType: "STRING_VALUE", // required
+ * //     Attributes: [ // ListOf__string
+ * //       "STRING_VALUE",
+ * //     ],
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param RemoveAttributesCommandInput - {@link RemoveAttributesCommandInput}
+ * @returns {@link RemoveAttributesCommandOutput}
+ * @see {@link RemoveAttributesCommandInput} for command's `input` shape.
+ * @see {@link RemoveAttributesCommandOutput} 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 RemoveAttributesCommand extends $Command<RemoveAttributesCommandInput, RemoveAttributesCommandOutput, PinpointClientResolvedConfig> {
+    readonly input: RemoveAttributesCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: RemoveAttributesCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveAttributesCommandInput, RemoveAttributesCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}