@aws-sdk/client-customer-profiles 3.341.0 → 3.344.0

package/dist-types/commands/ListCalculatedAttributeDefinitionsCommand.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 { ListCalculatedAttributeDefinitionsRequest, ListCalculatedAttributeDefinitionsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListCalculatedAttributeDefinitionsCommand}.
+ */
+export interface ListCalculatedAttributeDefinitionsCommandInput extends ListCalculatedAttributeDefinitionsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListCalculatedAttributeDefinitionsCommand}.
+ */
+export interface ListCalculatedAttributeDefinitionsCommandOutput extends ListCalculatedAttributeDefinitionsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Lists calculated attribute definitions for Customer Profiles</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CustomerProfilesClient, ListCalculatedAttributeDefinitionsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
+ * // const { CustomerProfilesClient, ListCalculatedAttributeDefinitionsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
+ * const client = new CustomerProfilesClient(config);
+ * const input = { // ListCalculatedAttributeDefinitionsRequest
+ *   DomainName: "STRING_VALUE", // required
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new ListCalculatedAttributeDefinitionsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListCalculatedAttributeDefinitionsResponse
+ * //   Items: [ // CalculatedAttributeDefinitionsList
+ * //     { // ListCalculatedAttributeDefinitionItem
+ * //       CalculatedAttributeName: "STRING_VALUE",
+ * //       DisplayName: "STRING_VALUE",
+ * //       Description: "STRING_VALUE",
+ * //       CreatedAt: new Date("TIMESTAMP"),
+ * //       LastUpdatedAt: new Date("TIMESTAMP"),
+ * //       Tags: { // TagMap
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListCalculatedAttributeDefinitionsCommandInput - {@link ListCalculatedAttributeDefinitionsCommandInput}
+ * @returns {@link ListCalculatedAttributeDefinitionsCommandOutput}
+ * @see {@link ListCalculatedAttributeDefinitionsCommandInput} for command's `input` shape.
+ * @see {@link ListCalculatedAttributeDefinitionsCommandOutput} 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 ListCalculatedAttributeDefinitionsCommand extends $Command<ListCalculatedAttributeDefinitionsCommandInput, ListCalculatedAttributeDefinitionsCommandOutput, CustomerProfilesClientResolvedConfig> {
+    readonly input: ListCalculatedAttributeDefinitionsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListCalculatedAttributeDefinitionsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListCalculatedAttributeDefinitionsCommandInput, ListCalculatedAttributeDefinitionsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,99 @@
+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 { ListCalculatedAttributesForProfileRequest, ListCalculatedAttributesForProfileResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListCalculatedAttributesForProfileCommand}.
+ */
+export interface ListCalculatedAttributesForProfileCommandInput extends ListCalculatedAttributesForProfileRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListCalculatedAttributesForProfileCommand}.
+ */
+export interface ListCalculatedAttributesForProfileCommandOutput extends ListCalculatedAttributesForProfileResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieve a list of calculated attributes for a customer profile.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CustomerProfilesClient, ListCalculatedAttributesForProfileCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
+ * // const { CustomerProfilesClient, ListCalculatedAttributesForProfileCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
+ * const client = new CustomerProfilesClient(config);
+ * const input = { // ListCalculatedAttributesForProfileRequest
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ *   DomainName: "STRING_VALUE", // required
+ *   ProfileId: "STRING_VALUE", // required
+ * };
+ * const command = new ListCalculatedAttributesForProfileCommand(input);
+ * const response = await client.send(command);
+ * // { // ListCalculatedAttributesForProfileResponse
+ * //   Items: [ // CalculatedAttributesForProfileList
+ * //     { // ListCalculatedAttributeForProfileItem
+ * //       CalculatedAttributeName: "STRING_VALUE",
+ * //       DisplayName: "STRING_VALUE",
+ * //       IsDataPartial: "STRING_VALUE",
+ * //       Value: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListCalculatedAttributesForProfileCommandInput - {@link ListCalculatedAttributesForProfileCommandInput}
+ * @returns {@link ListCalculatedAttributesForProfileCommandOutput}
+ * @see {@link ListCalculatedAttributesForProfileCommandInput} for command's `input` shape.
+ * @see {@link ListCalculatedAttributesForProfileCommandOutput} 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 ListCalculatedAttributesForProfileCommand extends $Command<ListCalculatedAttributesForProfileCommandInput, ListCalculatedAttributesForProfileCommandOutput, CustomerProfilesClientResolvedConfig> {
+    readonly input: ListCalculatedAttributesForProfileCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListCalculatedAttributesForProfileCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListCalculatedAttributesForProfileCommandInput, ListCalculatedAttributesForProfileCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,131 @@
+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 { UpdateCalculatedAttributeDefinitionRequest, UpdateCalculatedAttributeDefinitionResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateCalculatedAttributeDefinitionCommand}.
+ */
+export interface UpdateCalculatedAttributeDefinitionCommandInput extends UpdateCalculatedAttributeDefinitionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateCalculatedAttributeDefinitionCommand}.
+ */
+export interface UpdateCalculatedAttributeDefinitionCommandOutput extends UpdateCalculatedAttributeDefinitionResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates an existing calculated attribute definition. When updating the Conditions, note that increasing
+ *          the date range of a calculated attribute will not trigger inclusion of historical data greater than the
+ *          current date range.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CustomerProfilesClient, UpdateCalculatedAttributeDefinitionCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
+ * // const { CustomerProfilesClient, UpdateCalculatedAttributeDefinitionCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
+ * const client = new CustomerProfilesClient(config);
+ * const input = { // UpdateCalculatedAttributeDefinitionRequest
+ *   DomainName: "STRING_VALUE", // required
+ *   CalculatedAttributeName: "STRING_VALUE", // required
+ *   DisplayName: "STRING_VALUE",
+ *   Description: "STRING_VALUE",
+ *   Conditions: { // Conditions
+ *     Range: { // Range
+ *       Value: Number("int"), // required
+ *       Unit: "DAYS", // required
+ *     },
+ *     ObjectCount: Number("int"),
+ *     Threshold: { // Threshold
+ *       Value: "STRING_VALUE", // required
+ *       Operator: "EQUAL_TO" || "GREATER_THAN" || "LESS_THAN" || "NOT_EQUAL_TO", // required
+ *     },
+ *   },
+ * };
+ * const command = new UpdateCalculatedAttributeDefinitionCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateCalculatedAttributeDefinitionResponse
+ * //   CalculatedAttributeName: "STRING_VALUE",
+ * //   DisplayName: "STRING_VALUE",
+ * //   Description: "STRING_VALUE",
+ * //   CreatedAt: new Date("TIMESTAMP"),
+ * //   LastUpdatedAt: new Date("TIMESTAMP"),
+ * //   Statistic: "FIRST_OCCURRENCE" || "LAST_OCCURRENCE" || "COUNT" || "SUM" || "MINIMUM" || "MAXIMUM" || "AVERAGE" || "MAX_OCCURRENCE",
+ * //   Conditions: { // Conditions
+ * //     Range: { // Range
+ * //       Value: Number("int"), // required
+ * //       Unit: "DAYS", // required
+ * //     },
+ * //     ObjectCount: Number("int"),
+ * //     Threshold: { // Threshold
+ * //       Value: "STRING_VALUE", // required
+ * //       Operator: "EQUAL_TO" || "GREATER_THAN" || "LESS_THAN" || "NOT_EQUAL_TO", // required
+ * //     },
+ * //   },
+ * //   AttributeDetails: { // AttributeDetails
+ * //     Attributes: [ // AttributeList // required
+ * //       { // AttributeItem
+ * //         Name: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     Expression: "STRING_VALUE", // required
+ * //   },
+ * //   Tags: { // TagMap
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateCalculatedAttributeDefinitionCommandInput - {@link UpdateCalculatedAttributeDefinitionCommandInput}
+ * @returns {@link UpdateCalculatedAttributeDefinitionCommandOutput}
+ * @see {@link UpdateCalculatedAttributeDefinitionCommandInput} for command's `input` shape.
+ * @see {@link UpdateCalculatedAttributeDefinitionCommandOutput} 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 UpdateCalculatedAttributeDefinitionCommand extends $Command<UpdateCalculatedAttributeDefinitionCommandInput, UpdateCalculatedAttributeDefinitionCommandOutput, CustomerProfilesClientResolvedConfig> {
+    readonly input: UpdateCalculatedAttributeDefinitionCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateCalculatedAttributeDefinitionCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateCalculatedAttributeDefinitionCommandInput, UpdateCalculatedAttributeDefinitionCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,7 +1,9 @@
 export * from "./AddProfileKeyCommand";
+export * from "./CreateCalculatedAttributeDefinitionCommand";
 export * from "./CreateDomainCommand";
 export * from "./CreateIntegrationWorkflowCommand";
 export * from "./CreateProfileCommand";
+export * from "./DeleteCalculatedAttributeDefinitionCommand";
 export * from "./DeleteDomainCommand";
 export * from "./DeleteIntegrationCommand";
 export * from "./DeleteProfileCommand";
@@ -10,6 +12,8 @@ export * from "./DeleteProfileObjectCommand";
 export * from "./DeleteProfileObjectTypeCommand";
 export * from "./DeleteWorkflowCommand";
 export * from "./GetAutoMergingPreviewCommand";
+export * from "./GetCalculatedAttributeDefinitionCommand";
+export * from "./GetCalculatedAttributeForProfileCommand";
 export * from "./GetDomainCommand";
 export * from "./GetIdentityResolutionJobCommand";
 export * from "./GetIntegrationCommand";
@@ -19,6 +23,8 @@ export * from "./GetProfileObjectTypeTemplateCommand";
 export * from "./GetWorkflowCommand";
 export * from "./GetWorkflowStepsCommand";
 export * from "./ListAccountIntegrationsCommand";
+export * from "./ListCalculatedAttributeDefinitionsCommand";
+export * from "./ListCalculatedAttributesForProfileCommand";
 export * from "./ListDomainsCommand";
 export * from "./ListIdentityResolutionJobsCommand";
 export * from "./ListIntegrationsCommand";
@@ -34,5 +40,6 @@ export * from "./PutProfileObjectTypeCommand";
 export * from "./SearchProfilesCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateCalculatedAttributeDefinitionCommand";
 export * from "./UpdateDomainCommand";
 export * from "./UpdateProfileCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -13,7 +13,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
     defaultSigningName: string;
 };
 export interface EndpointParameters extends __EndpointParameters {
-    Region: string;
+    Region?: string;
     UseDualStack?: boolean;
     UseFIPS?: boolean;
     Endpoint?: string;