@aws-sdk/client-customer-profiles 3.693.0 → 3.696.0

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

@@ -60,7 +60,7 @@ declare const GetProfileObjectTypeTemplateCommand_base: {
  * //     "<keys>": [ // ObjectTypeKeyList
  * //       { // ObjectTypeKey
  * //         StandardIdentifiers: [ // StandardIdentifierList
- * //           "PROFILE" || "ASSET" || "CASE" || "UNIQUE" || "SECONDARY" || "LOOKUP_ONLY" || "NEW_ONLY" || "ORDER",
+ * //           "PROFILE" || "ASSET" || "CASE" || "ORDER" || "COMMUNICATION_RECORD" || "UNIQUE" || "SECONDARY" || "LOOKUP_ONLY" || "NEW_ONLY",
  * //         ],
  * //         FieldNames: [ // FieldNameList
  * //           "STRING_VALUE",

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

@@ -0,0 +1,216 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
+import { GetSegmentDefinitionRequest, GetSegmentDefinitionResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @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/smithy-client").CommandImpl<GetSegmentDefinitionCommandInput, GetSegmentDefinitionCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetSegmentDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<GetSegmentDefinitionCommandInput, GetSegmentDefinitionCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Gets a segment definition from the domain.</p>
+ * @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
+ * 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: "<ProfileDimension>",
+ * //               BirthDate: { // DateDimension
+ * //                 DimensionType: "BEFORE" || "AFTER" || "BETWEEN" || "NOT_BETWEEN" || "ON", // required
+ * //                 Values: [ // DateValues // required
+ * //                   "STRING_VALUE",
+ * //                 ],
+ * //               },
+ * //               PhoneNumber: "<ProfileDimension>",
+ * //               BusinessName: "<ProfileDimension>",
+ * //               BusinessPhoneNumber: "<ProfileDimension>",
+ * //               HomePhoneNumber: "<ProfileDimension>",
+ * //               MobilePhoneNumber: "<ProfileDimension>",
+ * //               EmailAddress: "<ProfileDimension>",
+ * //               PersonalEmailAddress: "<ProfileDimension>",
+ * //               BusinessEmailAddress: "<ProfileDimension>",
+ * //               Address: { // AddressDimension
+ * //                 City: "<ProfileDimension>",
+ * //                 Country: "<ProfileDimension>",
+ * //                 County: "<ProfileDimension>",
+ * //                 PostalCode: "<ProfileDimension>",
+ * //                 Province: "<ProfileDimension>",
+ * //                 State: "<ProfileDimension>",
+ * //               },
+ * //               ShippingAddress: {
+ * //                 City: "<ProfileDimension>",
+ * //                 Country: "<ProfileDimension>",
+ * //                 County: "<ProfileDimension>",
+ * //                 PostalCode: "<ProfileDimension>",
+ * //                 Province: "<ProfileDimension>",
+ * //                 State: "<ProfileDimension>",
+ * //               },
+ * //               MailingAddress: {
+ * //                 City: "<ProfileDimension>",
+ * //                 Country: "<ProfileDimension>",
+ * //                 County: "<ProfileDimension>",
+ * //                 PostalCode: "<ProfileDimension>",
+ * //                 Province: "<ProfileDimension>",
+ * //                 State: "<ProfileDimension>",
+ * //               },
+ * //               BillingAddress: {
+ * //                 City: "<ProfileDimension>",
+ * //                 Country: "<ProfileDimension>",
+ * //                 County: "<ProfileDimension>",
+ * //                 PostalCode: "<ProfileDimension>",
+ * //                 Province: "<ProfileDimension>",
+ * //                 State: "<ProfileDimension>",
+ * //               },
+ * //               Attributes: { // CustomAttributes
+ * //                 "<keys>": { // 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: "<Values>", // required
+ * //                 },
+ * //               },
+ * //             },
+ * //             CalculatedAttributes: { // CalculatedCustomAttributes
+ * //               "<keys>": { // 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: "<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",
+ * //   },
+ * //   SegmentDefinitionArn: "STRING_VALUE", // required
+ * //   CreatedAt: new Date("TIMESTAMP"),
+ * //   Tags: { // TagMap
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @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)
+ *  <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>
+ *
+ * @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;
+        };
+    };
+}

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

@@ -0,0 +1,92 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
+import { GetSegmentEstimateRequest, GetSegmentEstimateResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetSegmentEstimateCommand}.
+ */
+export interface GetSegmentEstimateCommandInput extends GetSegmentEstimateRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetSegmentEstimateCommand}.
+ */
+export interface GetSegmentEstimateCommandOutput extends GetSegmentEstimateResponse, __MetadataBearer {
+}
+declare const GetSegmentEstimateCommand_base: {
+    new (input: GetSegmentEstimateCommandInput): import("@smithy/smithy-client").CommandImpl<GetSegmentEstimateCommandInput, GetSegmentEstimateCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetSegmentEstimateCommandInput): import("@smithy/smithy-client").CommandImpl<GetSegmentEstimateCommandInput, GetSegmentEstimateCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Gets the result of a segment estimate query.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CustomerProfilesClient, GetSegmentEstimateCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
+ * // const { CustomerProfilesClient, GetSegmentEstimateCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
+ * const client = new CustomerProfilesClient(config);
+ * const input = { // GetSegmentEstimateRequest
+ *   DomainName: "STRING_VALUE", // required
+ *   EstimateId: "STRING_VALUE", // required
+ * };
+ * const command = new GetSegmentEstimateCommand(input);
+ * const response = await client.send(command);
+ * // { // GetSegmentEstimateResponse
+ * //   DomainName: "STRING_VALUE",
+ * //   EstimateId: "STRING_VALUE",
+ * //   Status: "RUNNING" || "SUCCEEDED" || "FAILED",
+ * //   Estimate: "STRING_VALUE",
+ * //   Message: "STRING_VALUE",
+ * //   StatusCode: Number("int"),
+ * // };
+ *
+ * ```
+ *
+ * @param GetSegmentEstimateCommandInput - {@link GetSegmentEstimateCommandInput}
+ * @returns {@link GetSegmentEstimateCommandOutput}
+ * @see {@link GetSegmentEstimateCommandInput} for command's `input` shape.
+ * @see {@link GetSegmentEstimateCommandOutput} 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>
+ *
+ * @public
+ */
+export declare class GetSegmentEstimateCommand extends GetSegmentEstimateCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetSegmentEstimateRequest;
+            output: GetSegmentEstimateResponse;
+        };
+        sdk: {
+            input: GetSegmentEstimateCommandInput;
+            output: GetSegmentEstimateCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,183 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
+import { GetSegmentMembershipRequest, GetSegmentMembershipResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetSegmentMembershipCommand}.
+ */
+export interface GetSegmentMembershipCommandInput extends GetSegmentMembershipRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetSegmentMembershipCommand}.
+ */
+export interface GetSegmentMembershipCommandOutput extends GetSegmentMembershipResponse, __MetadataBearer {
+}
+declare const GetSegmentMembershipCommand_base: {
+    new (input: GetSegmentMembershipCommandInput): import("@smithy/smithy-client").CommandImpl<GetSegmentMembershipCommandInput, GetSegmentMembershipCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetSegmentMembershipCommandInput): import("@smithy/smithy-client").CommandImpl<GetSegmentMembershipCommandInput, GetSegmentMembershipCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Determines if the given profiles are within a segment.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CustomerProfilesClient, GetSegmentMembershipCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
+ * // const { CustomerProfilesClient, GetSegmentMembershipCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
+ * const client = new CustomerProfilesClient(config);
+ * const input = { // GetSegmentMembershipRequest
+ *   DomainName: "STRING_VALUE", // required
+ *   SegmentDefinitionName: "STRING_VALUE", // required
+ *   ProfileIds: [ // ProfileIds // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new GetSegmentMembershipCommand(input);
+ * const response = await client.send(command);
+ * // { // GetSegmentMembershipResponse
+ * //   SegmentDefinitionName: "STRING_VALUE",
+ * //   Profiles: [ // Profiles
+ * //     { // ProfileQueryResult
+ * //       ProfileId: "STRING_VALUE", // required
+ * //       QueryResult: "PRESENT" || "ABSENT", // required
+ * //       Profile: { // Profile
+ * //         ProfileId: "STRING_VALUE",
+ * //         AccountNumber: "STRING_VALUE",
+ * //         AdditionalInformation: "STRING_VALUE",
+ * //         PartyType: "INDIVIDUAL" || "BUSINESS" || "OTHER",
+ * //         BusinessName: "STRING_VALUE",
+ * //         FirstName: "STRING_VALUE",
+ * //         MiddleName: "STRING_VALUE",
+ * //         LastName: "STRING_VALUE",
+ * //         BirthDate: "STRING_VALUE",
+ * //         Gender: "MALE" || "FEMALE" || "UNSPECIFIED",
+ * //         PhoneNumber: "STRING_VALUE",
+ * //         MobilePhoneNumber: "STRING_VALUE",
+ * //         HomePhoneNumber: "STRING_VALUE",
+ * //         BusinessPhoneNumber: "STRING_VALUE",
+ * //         EmailAddress: "STRING_VALUE",
+ * //         PersonalEmailAddress: "STRING_VALUE",
+ * //         BusinessEmailAddress: "STRING_VALUE",
+ * //         Address: { // Address
+ * //           Address1: "STRING_VALUE",
+ * //           Address2: "STRING_VALUE",
+ * //           Address3: "STRING_VALUE",
+ * //           Address4: "STRING_VALUE",
+ * //           City: "STRING_VALUE",
+ * //           County: "STRING_VALUE",
+ * //           State: "STRING_VALUE",
+ * //           Province: "STRING_VALUE",
+ * //           Country: "STRING_VALUE",
+ * //           PostalCode: "STRING_VALUE",
+ * //         },
+ * //         ShippingAddress: {
+ * //           Address1: "STRING_VALUE",
+ * //           Address2: "STRING_VALUE",
+ * //           Address3: "STRING_VALUE",
+ * //           Address4: "STRING_VALUE",
+ * //           City: "STRING_VALUE",
+ * //           County: "STRING_VALUE",
+ * //           State: "STRING_VALUE",
+ * //           Province: "STRING_VALUE",
+ * //           Country: "STRING_VALUE",
+ * //           PostalCode: "STRING_VALUE",
+ * //         },
+ * //         MailingAddress: {
+ * //           Address1: "STRING_VALUE",
+ * //           Address2: "STRING_VALUE",
+ * //           Address3: "STRING_VALUE",
+ * //           Address4: "STRING_VALUE",
+ * //           City: "STRING_VALUE",
+ * //           County: "STRING_VALUE",
+ * //           State: "STRING_VALUE",
+ * //           Province: "STRING_VALUE",
+ * //           Country: "STRING_VALUE",
+ * //           PostalCode: "STRING_VALUE",
+ * //         },
+ * //         BillingAddress: {
+ * //           Address1: "STRING_VALUE",
+ * //           Address2: "STRING_VALUE",
+ * //           Address3: "STRING_VALUE",
+ * //           Address4: "STRING_VALUE",
+ * //           City: "STRING_VALUE",
+ * //           County: "STRING_VALUE",
+ * //           State: "STRING_VALUE",
+ * //           Province: "STRING_VALUE",
+ * //           Country: "STRING_VALUE",
+ * //           PostalCode: "STRING_VALUE",
+ * //         },
+ * //         Attributes: { // Attributes
+ * //           "<keys>": "STRING_VALUE",
+ * //         },
+ * //         FoundByItems: [ // foundByList
+ * //           { // FoundByKeyValue
+ * //             KeyName: "STRING_VALUE",
+ * //             Values: [ // requestValueList
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         ],
+ * //         PartyTypeString: "STRING_VALUE",
+ * //         GenderString: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   Failures: [ // Failures
+ * //     { // ProfileQueryFailures
+ * //       ProfileId: "STRING_VALUE", // required
+ * //       Message: "STRING_VALUE", // required
+ * //       Status: Number("int"),
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param GetSegmentMembershipCommandInput - {@link GetSegmentMembershipCommandInput}
+ * @returns {@link GetSegmentMembershipCommandOutput}
+ * @see {@link GetSegmentMembershipCommandInput} for command's `input` shape.
+ * @see {@link GetSegmentMembershipCommandOutput} 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>
+ *
+ * @public
+ */
+export declare class GetSegmentMembershipCommand extends GetSegmentMembershipCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetSegmentMembershipRequest;
+            output: GetSegmentMembershipResponse;
+        };
+        sdk: {
+            input: GetSegmentMembershipCommandInput;
+            output: GetSegmentMembershipCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,94 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
+import { GetSegmentSnapshotRequest, GetSegmentSnapshotResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetSegmentSnapshotCommand}.
+ */
+export interface GetSegmentSnapshotCommandInput extends GetSegmentSnapshotRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetSegmentSnapshotCommand}.
+ */
+export interface GetSegmentSnapshotCommandOutput extends GetSegmentSnapshotResponse, __MetadataBearer {
+}
+declare const GetSegmentSnapshotCommand_base: {
+    new (input: GetSegmentSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl<GetSegmentSnapshotCommandInput, GetSegmentSnapshotCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetSegmentSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl<GetSegmentSnapshotCommandInput, GetSegmentSnapshotCommandOutput, CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieve the latest status of a segment snapshot.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CustomerProfilesClient, GetSegmentSnapshotCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
+ * // const { CustomerProfilesClient, GetSegmentSnapshotCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
+ * const client = new CustomerProfilesClient(config);
+ * const input = { // GetSegmentSnapshotRequest
+ *   DomainName: "STRING_VALUE", // required
+ *   SegmentDefinitionName: "STRING_VALUE", // required
+ *   SnapshotId: "STRING_VALUE", // required
+ * };
+ * const command = new GetSegmentSnapshotCommand(input);
+ * const response = await client.send(command);
+ * // { // GetSegmentSnapshotResponse
+ * //   SnapshotId: "STRING_VALUE", // required
+ * //   Status: "COMPLETED" || "IN_PROGRESS" || "FAILED", // required
+ * //   StatusMessage: "STRING_VALUE",
+ * //   DataFormat: "CSV" || "JSONL" || "ORC", // required
+ * //   EncryptionKey: "STRING_VALUE",
+ * //   RoleArn: "STRING_VALUE",
+ * //   DestinationUri: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetSegmentSnapshotCommandInput - {@link GetSegmentSnapshotCommandInput}
+ * @returns {@link GetSegmentSnapshotCommandOutput}
+ * @see {@link GetSegmentSnapshotCommandInput} for command's `input` shape.
+ * @see {@link GetSegmentSnapshotCommandOutput} 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>
+ *
+ * @public
+ */
+export declare class GetSegmentSnapshotCommand extends GetSegmentSnapshotCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetSegmentSnapshotRequest;
+            output: GetSegmentSnapshotResponse;
+        };
+        sdk: {
+            input: GetSegmentSnapshotCommandInput;
+            output: GetSegmentSnapshotCommandOutput;
+        };
+    };
+}