import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetSegmentDefinitionRequest, GetSegmentDefinitionResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetSegmentDefinitionCommand}. */ export interface GetSegmentDefinitionCommandInput extends GetSegmentDefinitionRequest { } /** * @public * * The output of {@link GetSegmentDefinitionCommand}. */ export interface GetSegmentDefinitionCommandOutput extends GetSegmentDefinitionResponse, __MetadataBearer { } declare const GetSegmentDefinitionCommand_base: { new (input: GetSegmentDefinitionCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetSegmentDefinitionCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Gets a segment definition from the domain.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CustomerProfilesClient, GetSegmentDefinitionCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import * // const { CustomerProfilesClient, GetSegmentDefinitionCommand } = 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 = { // GetSegmentDefinitionRequest * DomainName: "STRING_VALUE", // required * SegmentDefinitionName: "STRING_VALUE", // required * }; * const command = new GetSegmentDefinitionCommand(input); * const response = await client.send(command); * // { // GetSegmentDefinitionResponse * // SegmentDefinitionName: "STRING_VALUE", * // DisplayName: "STRING_VALUE", * // Description: "STRING_VALUE", * // SegmentGroups: { // SegmentGroup * // Groups: [ // SegmentGroupList * // { // Group * // Dimensions: [ // DimensionList * // { // Dimension Union: only one key present * // ProfileAttributes: { // ProfileAttributes * // AccountNumber: { // ProfileDimension * // DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required * // Values: [ // Values // required * // "STRING_VALUE", * // ], * // }, * // AdditionalInformation: { // ExtraLengthValueProfileDimension * // DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required * // Values: [ // ExtraLengthValues // required * // "STRING_VALUE", * // ], * // }, * // FirstName: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // LastName: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // MiddleName: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // GenderString: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEGINS_WITH" || "ENDS_WITH", // required * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // PartyTypeString: "", * // BirthDate: { // DateDimension * // DimensionType: "BEFORE" || "AFTER" || "BETWEEN" || "NOT_BETWEEN" || "ON", // required * // Values: [ // DateValues // required * // "STRING_VALUE", * // ], * // }, * // PhoneNumber: "", * // BusinessName: "", * // BusinessPhoneNumber: "", * // HomePhoneNumber: "", * // MobilePhoneNumber: "", * // EmailAddress: "", * // PersonalEmailAddress: "", * // BusinessEmailAddress: "", * // Address: { // AddressDimension * // City: "", * // Country: "", * // County: "", * // PostalCode: "", * // Province: "", * // State: "", * // }, * // ShippingAddress: { * // City: "", * // Country: "", * // County: "", * // PostalCode: "", * // Province: "", * // State: "", * // }, * // MailingAddress: { * // City: "", * // Country: "", * // County: "", * // PostalCode: "", * // Province: "", * // State: "", * // }, * // BillingAddress: { * // City: "", * // Country: "", * // County: "", * // PostalCode: "", * // Province: "", * // State: "", * // }, * // Attributes: { // CustomAttributes * // "": { // AttributeDimension * // 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: "", // required * // }, * // }, * // ProfileType: { // ProfileTypeDimension * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", // required * // Values: [ // ProfileTypeValues // required * // "ACCOUNT_PROFILE" || "PROFILE", * // ], * // }, * // }, * // CalculatedAttributes: { // CalculatedCustomAttributes * // "": { // CalculatedAttributeDimension * // 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: "", // required * // ConditionOverrides: { // ConditionOverrides * // Range: { // RangeOverride * // Start: Number("int"), // required * // End: Number("int"), * // Unit: "DAYS", // required * // }, * // }, * // }, * // }, * // }, * // ], * // SourceSegments: [ // SourceSegmentList * // { // SourceSegment * // SegmentDefinitionName: "STRING_VALUE", * // }, * // ], * // SourceType: "ALL" || "ANY" || "NONE", * // Type: "ALL" || "ANY" || "NONE", * // }, * // ], * // Include: "ALL" || "ANY" || "NONE", * // }, * // SegmentSort: { // SegmentSort * // Attributes: [ // SortAttributeList // required * // { // SortAttribute * // Name: "STRING_VALUE", // required * // DataType: "STRING" || "NUMBER" || "DATE", * // Order: "ASC" || "DESC", // required * // Type: "PROFILE" || "CALCULATED", * // }, * // ], * // }, * // SegmentDefinitionArn: "STRING_VALUE", // required * // CreatedAt: new Date("TIMESTAMP"), * // Tags: { // TagMap * // "": "STRING_VALUE", * // }, * // SegmentSqlQuery: "STRING_VALUE", * // SegmentType: "CLASSIC" || "ENHANCED", * // }; * * ``` * * @param GetSegmentDefinitionCommandInput - {@link GetSegmentDefinitionCommandInput} * @returns {@link GetSegmentDefinitionCommandOutput} * @see {@link GetSegmentDefinitionCommandInput} for command's `input` shape. * @see {@link GetSegmentDefinitionCommandOutput} 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 GetSegmentDefinitionCommand extends GetSegmentDefinitionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetSegmentDefinitionRequest; output: GetSegmentDefinitionResponse; }; sdk: { input: GetSegmentDefinitionCommandInput; output: GetSegmentDefinitionCommandOutput; }; }; }