@aws-sdk/client-customer-profiles 3.347.1 → 3.348.0

package/dist-types/commands/DeleteEventStreamCommand.d.ts

@@ -0,0 +1,87 @@
+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 { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
+import { DeleteEventStreamRequest, DeleteEventStreamResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteEventStreamCommand}.
+ */
+export interface DeleteEventStreamCommandInput extends DeleteEventStreamRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteEventStreamCommand}.
+ */
+export interface DeleteEventStreamCommandOutput extends DeleteEventStreamResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Disables and deletes the specified event stream.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CustomerProfilesClient, DeleteEventStreamCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
+ * // const { CustomerProfilesClient, DeleteEventStreamCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
+ * const client = new CustomerProfilesClient(config);
+ * const input = { // DeleteEventStreamRequest
+ *   DomainName: "STRING_VALUE", // required
+ *   EventStreamName: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteEventStreamCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteEventStreamCommandInput - {@link DeleteEventStreamCommandInput}
+ * @returns {@link DeleteEventStreamCommandOutput}
+ * @see {@link DeleteEventStreamCommandInput} for command's `input` shape.
+ * @see {@link DeleteEventStreamCommandOutput} for command's `response` shape.
+ * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input you provided is invalid.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal service error occurred.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource does not exist, or access was denied.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>You exceeded the maximum number of requests.</p>
+ *
+ * @throws {@link CustomerProfilesServiceException}
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
+ *
+ */
+export declare class DeleteEventStreamCommand extends $Command<DeleteEventStreamCommandInput, DeleteEventStreamCommandOutput, CustomerProfilesClientResolvedConfig> {
+    readonly input: DeleteEventStreamCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DeleteEventStreamCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteEventStreamCommandInput, DeleteEventStreamCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/GetEventStreamCommand.d.ts

@@ -0,0 +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 { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
+import { GetEventStreamRequest, GetEventStreamResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetEventStreamCommand}.
+ */
+export interface GetEventStreamCommandInput extends GetEventStreamRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetEventStreamCommand}.
+ */
+export interface GetEventStreamCommandOutput extends GetEventStreamResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Returns information about the specified event stream in a specific domain.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CustomerProfilesClient, GetEventStreamCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
+ * // const { CustomerProfilesClient, GetEventStreamCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
+ * const client = new CustomerProfilesClient(config);
+ * const input = { // GetEventStreamRequest
+ *   DomainName: "STRING_VALUE", // required
+ *   EventStreamName: "STRING_VALUE", // required
+ * };
+ * const command = new GetEventStreamCommand(input);
+ * const response = await client.send(command);
+ * // { // GetEventStreamResponse
+ * //   DomainName: "STRING_VALUE", // required
+ * //   EventStreamArn: "STRING_VALUE", // required
+ * //   CreatedAt: new Date("TIMESTAMP"), // required
+ * //   State: "RUNNING" || "STOPPED", // required
+ * //   StoppedSince: new Date("TIMESTAMP"),
+ * //   DestinationDetails: { // EventStreamDestinationDetails
+ * //     Uri: "STRING_VALUE", // required
+ * //     Status: "HEALTHY" || "UNHEALTHY", // required
+ * //     UnhealthySince: new Date("TIMESTAMP"),
+ * //     Message: "STRING_VALUE",
+ * //   },
+ * //   Tags: { // TagMap
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetEventStreamCommandInput - {@link GetEventStreamCommandInput}
+ * @returns {@link GetEventStreamCommandOutput}
+ * @see {@link GetEventStreamCommandInput} for command's `input` shape.
+ * @see {@link GetEventStreamCommandOutput} for command's `response` shape.
+ * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input you provided is invalid.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal service error occurred.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource does not exist, or access was denied.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>You exceeded the maximum number of requests.</p>
+ *
+ * @throws {@link CustomerProfilesServiceException}
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
+ *
+ */
+export declare class GetEventStreamCommand extends $Command<GetEventStreamCommandInput, GetEventStreamCommandOutput, CustomerProfilesClientResolvedConfig> {
+    readonly input: GetEventStreamCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetEventStreamCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEventStreamCommandInput, GetEventStreamCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/ListEventStreamsCommand.d.ts

@@ -0,0 +1,107 @@
+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 { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
+import { ListEventStreamsRequest, ListEventStreamsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListEventStreamsCommand}.
+ */
+export interface ListEventStreamsCommandInput extends ListEventStreamsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListEventStreamsCommand}.
+ */
+export interface ListEventStreamsCommandOutput extends ListEventStreamsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Returns a list of all the event streams in a specific domain.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CustomerProfilesClient, ListEventStreamsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
+ * // const { CustomerProfilesClient, ListEventStreamsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
+ * const client = new CustomerProfilesClient(config);
+ * const input = { // ListEventStreamsRequest
+ *   DomainName: "STRING_VALUE", // required
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new ListEventStreamsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListEventStreamsResponse
+ * //   Items: [ // EventStreamSummaryList
+ * //     { // EventStreamSummary
+ * //       DomainName: "STRING_VALUE", // required
+ * //       EventStreamName: "STRING_VALUE", // required
+ * //       EventStreamArn: "STRING_VALUE", // required
+ * //       State: "RUNNING" || "STOPPED", // required
+ * //       StoppedSince: new Date("TIMESTAMP"),
+ * //       DestinationSummary: { // DestinationSummary
+ * //         Uri: "STRING_VALUE", // required
+ * //         Status: "HEALTHY" || "UNHEALTHY", // required
+ * //         UnhealthySince: new Date("TIMESTAMP"),
+ * //       },
+ * //       Tags: { // TagMap
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListEventStreamsCommandInput - {@link ListEventStreamsCommandInput}
+ * @returns {@link ListEventStreamsCommandOutput}
+ * @see {@link ListEventStreamsCommandInput} for command's `input` shape.
+ * @see {@link ListEventStreamsCommandOutput} for command's `response` shape.
+ * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input you provided is invalid.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal service error occurred.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource does not exist, or access was denied.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>You exceeded the maximum number of requests.</p>
+ *
+ * @throws {@link CustomerProfilesServiceException}
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
+ *
+ */
+export declare class ListEventStreamsCommand extends $Command<ListEventStreamsCommandInput, ListEventStreamsCommandOutput, CustomerProfilesClientResolvedConfig> {
+    readonly input: ListEventStreamsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListEventStreamsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListEventStreamsCommandInput, ListEventStreamsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -1,10 +1,12 @@
 export * from "./AddProfileKeyCommand";
 export * from "./CreateCalculatedAttributeDefinitionCommand";
 export * from "./CreateDomainCommand";
+export * from "./CreateEventStreamCommand";
 export * from "./CreateIntegrationWorkflowCommand";
 export * from "./CreateProfileCommand";
 export * from "./DeleteCalculatedAttributeDefinitionCommand";
 export * from "./DeleteDomainCommand";
+export * from "./DeleteEventStreamCommand";
 export * from "./DeleteIntegrationCommand";
 export * from "./DeleteProfileCommand";
 export * from "./DeleteProfileKeyCommand";
@@ -15,6 +17,7 @@ export * from "./GetAutoMergingPreviewCommand";
 export * from "./GetCalculatedAttributeDefinitionCommand";
 export * from "./GetCalculatedAttributeForProfileCommand";
 export * from "./GetDomainCommand";
+export * from "./GetEventStreamCommand";
 export * from "./GetIdentityResolutionJobCommand";
 export * from "./GetIntegrationCommand";
 export * from "./GetMatchesCommand";
@@ -26,6 +29,7 @@ export * from "./ListAccountIntegrationsCommand";
 export * from "./ListCalculatedAttributeDefinitionsCommand";
 export * from "./ListCalculatedAttributesForProfileCommand";
 export * from "./ListDomainsCommand";
+export * from "./ListEventStreamsCommand";
 export * from "./ListIdentityResolutionJobsCommand";
 export * from "./ListIntegrationsCommand";
 export * from "./ListProfileObjectTypeTemplatesCommand";

package/dist-types/index.d.ts

@@ -11,5 +11,6 @@
 export * from "./CustomerProfilesClient";
 export * from "./CustomerProfiles";
 export * from "./commands";
+export * from "./pagination";
 export * from "./models";
 export { CustomerProfilesServiceException } from "./models/CustomerProfilesServiceException";

package/dist-types/models/models_0.d.ts

@@ -1313,6 +1313,41 @@ export interface CreateDomainResponse {
      */
     Tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
+export interface CreateEventStreamRequest {
+    /**
+     * <p>The unique name of the domain.</p>
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The StreamARN of the destination to deliver profile events to. For example,
+     *          arn:aws:kinesis:region:account-id:stream/stream-name</p>
+     */
+    Uri: string | undefined;
+    /**
+     * <p>The name of the event stream.</p>
+     */
+    EventStreamName: string | undefined;
+    /**
+     * <p>The tags used to organize, track, or control access for this resource.</p>
+     */
+    Tags?: Record<string, string>;
+}
+/**
+ * @public
+ */
+export interface CreateEventStreamResponse {
+    /**
+     * <p>A unique identifier for the event stream.</p>
+     */
+    EventStreamArn: string | undefined;
+    /**
+     * <p>The tags used to organize, track, or control access for this resource.</p>
+     */
+    Tags?: Record<string, string>;
+}
 /**
  * @public
  * <p>Configuration data for integration workflow.</p>
@@ -1555,6 +1590,24 @@ export interface DeleteDomainResponse {
      */
     Message: string | undefined;
 }
+/**
+ * @public
+ */
+export interface DeleteEventStreamRequest {
+    /**
+     * <p>The unique name of the domain.</p>
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The name of the event stream</p>
+     */
+    EventStreamName: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteEventStreamResponse {
+}
 /**
  * @public
  */
@@ -1917,6 +1970,99 @@ export interface GetDomainResponse {
      */
     Tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
+export interface GetEventStreamRequest {
+    /**
+     * <p>The unique name of the domain.</p>
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The name of the event stream provided during create operations.</p>
+     */
+    EventStreamName: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const EventStreamDestinationStatus: {
+    readonly HEALTHY: "HEALTHY";
+    readonly UNHEALTHY: "UNHEALTHY";
+};
+/**
+ * @public
+ */
+export type EventStreamDestinationStatus = (typeof EventStreamDestinationStatus)[keyof typeof EventStreamDestinationStatus];
+/**
+ * @public
+ * <p>Details of the destination being used for the EventStream.</p>
+ */
+export interface EventStreamDestinationDetails {
+    /**
+     * <p>The StreamARN of the destination to deliver profile events to. For example,
+     *          arn:aws:kinesis:region:account-id:stream/stream-name.</p>
+     */
+    Uri: string | undefined;
+    /**
+     * <p>The status of enabling the Kinesis stream as a destination for export.</p>
+     */
+    Status: EventStreamDestinationStatus | string | undefined;
+    /**
+     * <p>The timestamp when the status last changed to <code>UNHEALHY</code>.</p>
+     */
+    UnhealthySince?: Date;
+    /**
+     * <p>The human-readable string that corresponds to the error or success while enabling the streaming destination.</p>
+     */
+    Message?: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const EventStreamState: {
+    readonly RUNNING: "RUNNING";
+    readonly STOPPED: "STOPPED";
+};
+/**
+ * @public
+ */
+export type EventStreamState = (typeof EventStreamState)[keyof typeof EventStreamState];
+/**
+ * @public
+ */
+export interface GetEventStreamResponse {
+    /**
+     * <p>The unique name of the domain.</p>
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>A unique identifier for the event stream.</p>
+     */
+    EventStreamArn: string | undefined;
+    /**
+     * <p>The timestamp of when the export was created.</p>
+     */
+    CreatedAt: Date | undefined;
+    /**
+     * <p>The operational state of destination stream for export.</p>
+     */
+    State: EventStreamState | string | undefined;
+    /**
+     * <p>The timestamp when the <code>State</code> changed to <code>STOPPED</code>.</p>
+     */
+    StoppedSince?: Date;
+    /**
+     * <p>Details regarding the Kinesis stream.</p>
+     */
+    DestinationDetails: EventStreamDestinationDetails | undefined;
+    /**
+     * <p>The tags used to organize, track, or control access for this resource.</p>
+     */
+    Tags?: Record<string, string>;
+}
 /**
  * @public
  */
@@ -2701,6 +2847,89 @@ export interface ListDomainsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
+export interface ListEventStreamsRequest {
+    /**
+     * <p>The unique name of the domain.</p>
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>Identifies the next page of results to return.</p>
+     */
+    NextToken?: string;
+    /**
+     * <p>The maximum number of objects returned per page.</p>
+     */
+    MaxResults?: number;
+}
+/**
+ * @public
+ * <p>Summary information about the Kinesis data stream</p>
+ */
+export interface DestinationSummary {
+    /**
+     * <p>The StreamARN of the destination to deliver profile events to. For example,
+     *          arn:aws:kinesis:region:account-id:stream/stream-name.</p>
+     */
+    Uri: string | undefined;
+    /**
+     * <p>The status of enabling the Kinesis stream as a destination for export.</p>
+     */
+    Status: EventStreamDestinationStatus | string | undefined;
+    /**
+     * <p>The timestamp when the status last changed to <code>UNHEALHY</code>.</p>
+     */
+    UnhealthySince?: Date;
+}
+/**
+ * @public
+ * <p>An instance of EventStream in a list of EventStreams.</p>
+ */
+export interface EventStreamSummary {
+    /**
+     * <p>The unique name of the domain.</p>
+     */
+    DomainName: string | undefined;
+    /**
+     * <p>The name of the event stream.</p>
+     */
+    EventStreamName: string | undefined;
+    /**
+     * <p>A unique identifier for the event stream.</p>
+     */
+    EventStreamArn: string | undefined;
+    /**
+     * <p>The operational state of destination stream for export.</p>
+     */
+    State: EventStreamState | string | undefined;
+    /**
+     * <p>The timestamp when the <code>State</code> changed to <code>STOPPED</code>.</p>
+     */
+    StoppedSince?: Date;
+    /**
+     * <p>Summary information about the Kinesis data stream.</p>
+     */
+    DestinationSummary?: DestinationSummary;
+    /**
+     * <p>The tags used to organize, track, or control access for this resource.</p>
+     */
+    Tags?: Record<string, string>;
+}
+/**
+ * @public
+ */
+export interface ListEventStreamsResponse {
+    /**
+     * <p>Contains summary information about an EventStream.</p>
+     */
+    Items?: EventStreamSummary[];
+    /**
+     * <p>Identifies the next page of results to return.</p>
+     */
+    NextToken?: string;
+}
 /**
  * @public
  */

package/dist-types/pagination/Interfaces.d.ts

@@ -0,0 +1,8 @@
+import { PaginationConfiguration } from "@aws-sdk/types";
+import { CustomerProfilesClient } from "../CustomerProfilesClient";
+/**
+ * @public
+ */
+export interface CustomerProfilesPaginationConfiguration extends PaginationConfiguration {
+    client: CustomerProfilesClient;
+}

package/dist-types/pagination/ListEventStreamsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListEventStreamsCommandInput, ListEventStreamsCommandOutput } from "../commands/ListEventStreamsCommand";
+import { CustomerProfilesPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare function paginateListEventStreams(config: CustomerProfilesPaginationConfiguration, input: ListEventStreamsCommandInput, ...additionalArguments: any): Paginator<ListEventStreamsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Interfaces";
+export * from "./ListEventStreamsPaginator";