import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { UpdateSegmentRequest, UpdateSegmentResponse } from "../models/models_1"; import type { PinpointClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateSegmentCommand}. */ export interface UpdateSegmentCommandInput extends UpdateSegmentRequest { } /** * @public * * The output of {@link UpdateSegmentCommand}. */ export interface UpdateSegmentCommandOutput extends UpdateSegmentResponse, __MetadataBearer { } declare const UpdateSegmentCommand_base: { new (input: UpdateSegmentCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: UpdateSegmentCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { PinpointClient, UpdateSegmentCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import * // const { PinpointClient, UpdateSegmentCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import * // import type { PinpointClientConfig } from "@aws-sdk/client-pinpoint"; * const config = {}; // type is PinpointClientConfig * const client = new PinpointClient(config); * const input = { // UpdateSegmentRequest * ApplicationId: "STRING_VALUE", // required * SegmentId: "STRING_VALUE", // required * WriteSegmentRequest: { // WriteSegmentRequest * Dimensions: { // SegmentDimensions * Attributes: { // MapOfAttributeDimension * "": { // AttributeDimension * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * Values: [ // ListOf__string // required * "STRING_VALUE", * ], * }, * }, * Behavior: { // SegmentBehaviors * Recency: { // RecencyDimension * Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required * RecencyType: "ACTIVE" || "INACTIVE", // required * }, * }, * Demographic: { // SegmentDemographics * AppVersion: { // SetDimension * DimensionType: "INCLUSIVE" || "EXCLUSIVE", * Values: [ // required * "STRING_VALUE", * ], * }, * Channel: { * DimensionType: "INCLUSIVE" || "EXCLUSIVE", * Values: [ // required * "STRING_VALUE", * ], * }, * DeviceType: { * DimensionType: "INCLUSIVE" || "EXCLUSIVE", * Values: [ // required * "STRING_VALUE", * ], * }, * Make: { * DimensionType: "INCLUSIVE" || "EXCLUSIVE", * Values: [ // required * "STRING_VALUE", * ], * }, * Model: { * DimensionType: "INCLUSIVE" || "EXCLUSIVE", * Values: "", // required * }, * Platform: "", * }, * Location: { // SegmentLocation * Country: "", * GPSPoint: { // GPSPointDimension * Coordinates: { // GPSCoordinates * Latitude: Number("double"), // required * Longitude: Number("double"), // required * }, * RangeInKilometers: Number("double"), * }, * }, * Metrics: { // MapOfMetricDimension * "": { // MetricDimension * ComparisonOperator: "STRING_VALUE", // required * Value: Number("double"), // required * }, * }, * UserAttributes: { * "": { * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * Values: "", // required * }, * }, * }, * Name: "STRING_VALUE", * SegmentGroups: { // SegmentGroupList * Groups: [ // ListOfSegmentGroup * { // SegmentGroup * Dimensions: [ // ListOfSegmentDimensions * { * Attributes: { * "": { * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * Values: "", // required * }, * }, * Behavior: { * Recency: { * Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required * RecencyType: "ACTIVE" || "INACTIVE", // required * }, * }, * Demographic: { * AppVersion: "", * Channel: "", * DeviceType: "", * Make: "", * Model: "", * Platform: "", * }, * Location: { * Country: "", * GPSPoint: { * Coordinates: { * Latitude: Number("double"), // required * Longitude: Number("double"), // required * }, * RangeInKilometers: Number("double"), * }, * }, * Metrics: { * "": { * ComparisonOperator: "STRING_VALUE", // required * Value: Number("double"), // required * }, * }, * UserAttributes: { * "": { * AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * Values: "", // required * }, * }, * }, * ], * SourceSegments: [ // ListOfSegmentReference * { // SegmentReference * Id: "STRING_VALUE", // required * Version: Number("int"), * }, * ], * SourceType: "ALL" || "ANY" || "NONE", * Type: "ALL" || "ANY" || "NONE", * }, * ], * Include: "ALL" || "ANY" || "NONE", * }, * tags: { // MapOf__string * "": "STRING_VALUE", * }, * }, * }; * const command = new UpdateSegmentCommand(input); * const response = await client.send(command); * // { // UpdateSegmentResponse * // SegmentResponse: { // SegmentResponse * // ApplicationId: "STRING_VALUE", // required * // Arn: "STRING_VALUE", // required * // CreationDate: "STRING_VALUE", // required * // Dimensions: { // SegmentDimensions * // Attributes: { // MapOfAttributeDimension * // "": { // AttributeDimension * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * // Values: [ // ListOf__string // required * // "STRING_VALUE", * // ], * // }, * // }, * // Behavior: { // SegmentBehaviors * // Recency: { // RecencyDimension * // Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required * // RecencyType: "ACTIVE" || "INACTIVE", // required * // }, * // }, * // Demographic: { // SegmentDemographics * // AppVersion: { // SetDimension * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // Channel: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // DeviceType: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // Make: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", * // Values: [ // required * // "STRING_VALUE", * // ], * // }, * // Model: { * // DimensionType: "INCLUSIVE" || "EXCLUSIVE", * // Values: "", // required * // }, * // Platform: "", * // }, * // Location: { // SegmentLocation * // Country: "", * // GPSPoint: { // GPSPointDimension * // Coordinates: { // GPSCoordinates * // Latitude: Number("double"), // required * // Longitude: Number("double"), // required * // }, * // RangeInKilometers: Number("double"), * // }, * // }, * // Metrics: { // MapOfMetricDimension * // "": { // MetricDimension * // ComparisonOperator: "STRING_VALUE", // required * // Value: Number("double"), // required * // }, * // }, * // UserAttributes: { * // "": { * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * // Values: "", // required * // }, * // }, * // }, * // Id: "STRING_VALUE", // required * // ImportDefinition: { // SegmentImportResource * // ChannelCounts: { // MapOf__integer * // "": Number("int"), * // }, * // ExternalId: "STRING_VALUE", // required * // Format: "CSV" || "JSON", // required * // RoleArn: "STRING_VALUE", // required * // S3Url: "STRING_VALUE", // required * // Size: Number("int"), // required * // }, * // LastModifiedDate: "STRING_VALUE", * // Name: "STRING_VALUE", * // SegmentGroups: { // SegmentGroupList * // Groups: [ // ListOfSegmentGroup * // { // SegmentGroup * // Dimensions: [ // ListOfSegmentDimensions * // { * // Attributes: { * // "": { * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * // Values: "", // required * // }, * // }, * // Behavior: { * // Recency: { * // Duration: "HR_24" || "DAY_7" || "DAY_14" || "DAY_30", // required * // RecencyType: "ACTIVE" || "INACTIVE", // required * // }, * // }, * // Demographic: { * // AppVersion: "", * // Channel: "", * // DeviceType: "", * // Make: "", * // Model: "", * // Platform: "", * // }, * // Location: { * // Country: "", * // GPSPoint: { * // Coordinates: { * // Latitude: Number("double"), // required * // Longitude: Number("double"), // required * // }, * // RangeInKilometers: Number("double"), * // }, * // }, * // Metrics: { * // "": { * // ComparisonOperator: "STRING_VALUE", // required * // Value: Number("double"), // required * // }, * // }, * // UserAttributes: { * // "": { * // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN", * // Values: "", // required * // }, * // }, * // }, * // ], * // SourceSegments: [ // ListOfSegmentReference * // { // SegmentReference * // Id: "STRING_VALUE", // required * // Version: Number("int"), * // }, * // ], * // SourceType: "ALL" || "ANY" || "NONE", * // Type: "ALL" || "ANY" || "NONE", * // }, * // ], * // Include: "ALL" || "ANY" || "NONE", * // }, * // SegmentType: "DIMENSIONAL" || "IMPORT", // required * // tags: { // MapOf__string * // "": "STRING_VALUE", * // }, * // Version: Number("int"), * // }, * // }; * * ``` * * @param UpdateSegmentCommandInput - {@link UpdateSegmentCommandInput} * @returns {@link UpdateSegmentCommandOutput} * @see {@link UpdateSegmentCommandInput} for command's `input` shape. * @see {@link UpdateSegmentCommandOutput} for command's `response` shape. * @see {@link PinpointClientResolvedConfig | config} for PinpointClient's `config` shape. * * @throws {@link BadRequestException} (client fault) *

Provides information about an API request or response.

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

Provides information about an API request or response.

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

Provides information about an API request or response.

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

Provides information about an API request or response.

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

Provides information about an API request or response.

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

Provides information about an API request or response.

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

Provides information about an API request or response.

* * @throws {@link PinpointServiceException} *

Base exception class for all service exceptions from Pinpoint service.

* * * @public */ export declare class UpdateSegmentCommand extends UpdateSegmentCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateSegmentRequest; output: UpdateSegmentResponse; }; sdk: { input: UpdateSegmentCommandInput; output: UpdateSegmentCommandOutput; }; }; }