import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateCalculatedAttributeDefinitionRequest, CreateCalculatedAttributeDefinitionResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateCalculatedAttributeDefinitionCommand}. */ export interface CreateCalculatedAttributeDefinitionCommandInput extends CreateCalculatedAttributeDefinitionRequest { } /** * @public * * The output of {@link CreateCalculatedAttributeDefinitionCommand}. */ export interface CreateCalculatedAttributeDefinitionCommandOutput extends CreateCalculatedAttributeDefinitionResponse, __MetadataBearer { } declare const CreateCalculatedAttributeDefinitionCommand_base: { new (input: CreateCalculatedAttributeDefinitionCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateCalculatedAttributeDefinitionCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Creates a new calculated attribute definition. After creation, new object data ingested * into Customer Profiles will be included in the calculated attribute, which can be retrieved * for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it * available for all profiles within a domain. Each calculated attribute can only reference * one ObjectType and at most, two fields from that * ObjectType.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CustomerProfilesClient, CreateCalculatedAttributeDefinitionCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import * // const { CustomerProfilesClient, CreateCalculatedAttributeDefinitionCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import * // import type { CustomerProfilesClientConfig } from "@aws-sdk/client-customer-profiles"; * const config = {}; // type is CustomerProfilesClientConfig * const client = new CustomerProfilesClient(config); * const input = { // CreateCalculatedAttributeDefinitionRequest * DomainName: "STRING_VALUE", // required * CalculatedAttributeName: "STRING_VALUE", // required * DisplayName: "STRING_VALUE", * Description: "STRING_VALUE", * AttributeDetails: { // AttributeDetails * Attributes: [ // AttributeList // required * { // AttributeItem * Name: "STRING_VALUE", // required * }, * ], * Expression: "STRING_VALUE", // required * }, * Conditions: { // Conditions * Range: { // Range * Value: Number("int"), * Unit: "DAYS", * ValueRange: { // ValueRange * Start: Number("int"), // required * End: Number("int"), // required * }, * TimestampSource: "STRING_VALUE", * TimestampFormat: "STRING_VALUE", * }, * ObjectCount: Number("int"), * Threshold: { // Threshold * Value: "STRING_VALUE", // required * Operator: "EQUAL_TO" || "GREATER_THAN" || "LESS_THAN" || "NOT_EQUAL_TO", // required * }, * }, * Filter: { // Filter * Include: "ALL" || "ANY" || "NONE", // required * Groups: [ // GroupList // required * { // FilterGroup * Type: "ALL" || "ANY" || "NONE", // required * Dimensions: [ // FilterDimensionList // required * { // FilterDimension * Attributes: { // AttributeMap // required * "": { // FilterAttributeDimension * DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH" || "BEFORE" || "AFTER" || "BETWEEN" || "NOT_BETWEEN" || "ON" || "GREATER_THAN" || "LESS_THAN" || "GREATER_THAN_OR_EQUAL" || "LESS_THAN_OR_EQUAL" || "EQUAL", // required * Values: [ // ValueList // required * "STRING_VALUE", * ], * }, * }, * }, * ], * }, * ], * }, * Statistic: "FIRST_OCCURRENCE" || "LAST_OCCURRENCE" || "COUNT" || "SUM" || "MINIMUM" || "MAXIMUM" || "AVERAGE" || "MAX_OCCURRENCE", // required * UseHistoricalData: true || false, * Tags: { // TagMap * "": "STRING_VALUE", * }, * }; * const command = new CreateCalculatedAttributeDefinitionCommand(input); * const response = await client.send(command); * // { // CreateCalculatedAttributeDefinitionResponse * // CalculatedAttributeName: "STRING_VALUE", * // DisplayName: "STRING_VALUE", * // Description: "STRING_VALUE", * // AttributeDetails: { // AttributeDetails * // Attributes: [ // AttributeList // required * // { // AttributeItem * // Name: "STRING_VALUE", // required * // }, * // ], * // Expression: "STRING_VALUE", // required * // }, * // Conditions: { // Conditions * // Range: { // Range * // Value: Number("int"), * // Unit: "DAYS", * // ValueRange: { // ValueRange * // Start: Number("int"), // required * // End: Number("int"), // required * // }, * // TimestampSource: "STRING_VALUE", * // TimestampFormat: "STRING_VALUE", * // }, * // ObjectCount: Number("int"), * // Threshold: { // Threshold * // Value: "STRING_VALUE", // required * // Operator: "EQUAL_TO" || "GREATER_THAN" || "LESS_THAN" || "NOT_EQUAL_TO", // required * // }, * // }, * // Filter: { // Filter * // Include: "ALL" || "ANY" || "NONE", // required * // Groups: [ // GroupList // required * // { // FilterGroup * // Type: "ALL" || "ANY" || "NONE", // required * // Dimensions: [ // FilterDimensionList // required * // { // FilterDimension * // Attributes: { // AttributeMap // required * // "": { // FilterAttributeDimension * // DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH" || "BEFORE" || "AFTER" || "BETWEEN" || "NOT_BETWEEN" || "ON" || "GREATER_THAN" || "LESS_THAN" || "GREATER_THAN_OR_EQUAL" || "LESS_THAN_OR_EQUAL" || "EQUAL", // required * // Values: [ // ValueList // required * // "STRING_VALUE", * // ], * // }, * // }, * // }, * // ], * // }, * // ], * // }, * // Statistic: "FIRST_OCCURRENCE" || "LAST_OCCURRENCE" || "COUNT" || "SUM" || "MINIMUM" || "MAXIMUM" || "AVERAGE" || "MAX_OCCURRENCE", * // CreatedAt: new Date("TIMESTAMP"), * // LastUpdatedAt: new Date("TIMESTAMP"), * // UseHistoricalData: true || false, * // Status: "PREPARING" || "IN_PROGRESS" || "COMPLETED" || "FAILED", * // Readiness: { // Readiness * // ProgressPercentage: Number("int"), * // Message: "STRING_VALUE", * // }, * // Tags: { // TagMap * // "": "STRING_VALUE", * // }, * // }; * * ``` * * @param CreateCalculatedAttributeDefinitionCommandInput - {@link CreateCalculatedAttributeDefinitionCommandInput} * @returns {@link CreateCalculatedAttributeDefinitionCommandOutput} * @see {@link CreateCalculatedAttributeDefinitionCommandInput} for command's `input` shape. * @see {@link CreateCalculatedAttributeDefinitionCommandOutput} for command's `response` shape. * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You do not have sufficient access to perform this action.

* * @throws {@link BadRequestException} (client fault) *

The input you provided is invalid.

* * @throws {@link InternalServerException} (server fault) *

An internal service error occurred.

* * @throws {@link ResourceNotFoundException} (client fault) *

The requested resource does not exist, or access was denied.

* * @throws {@link ThrottlingException} (client fault) *

You exceeded the maximum number of requests.

* * @throws {@link CustomerProfilesServiceException} *

Base exception class for all service exceptions from CustomerProfiles service.

* * * @public */ export declare class CreateCalculatedAttributeDefinitionCommand extends CreateCalculatedAttributeDefinitionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateCalculatedAttributeDefinitionRequest; output: CreateCalculatedAttributeDefinitionResponse; }; sdk: { input: CreateCalculatedAttributeDefinitionCommandInput; output: CreateCalculatedAttributeDefinitionCommandOutput; }; }; }