@aws-sdk/client-customer-profiles 3.1120.0 → 3.1122.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +49 -0
- package/dist-cjs/index.js +266 -7
- package/dist-es/CustomerProfiles.js +16 -0
- package/dist-es/commands/AssociateStreamForSegmentsCommand.js +4 -0
- package/dist-es/commands/DeleteSegmentSubscriptionCommand.js +4 -0
- package/dist-es/commands/DisassociateStreamForSegmentsCommand.js +4 -0
- package/dist-es/commands/GetSegmentSubscriptionCommand.js +4 -0
- package/dist-es/commands/GetStreamForSegmentsCommand.js +4 -0
- package/dist-es/commands/ListSegmentSubscriptionEventsCommand.js +4 -0
- package/dist-es/commands/PutSegmentSubscriptionCommand.js +4 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/models/enums.js +31 -0
- package/dist-es/pagination/ListSegmentSubscriptionEventsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +164 -6
- package/dist-types/CustomerProfiles.d.ts +56 -0
- package/dist-types/CustomerProfilesClient.d.ts +9 -2
- package/dist-types/commands/AssociateStreamForSegmentsCommand.d.ts +89 -0
- package/dist-types/commands/CreateCalculatedAttributeDefinitionCommand.d.ts +2 -2
- package/dist-types/commands/CreateSegmentDefinitionCommand.d.ts +2 -2
- package/dist-types/commands/CreateSegmentEstimateCommand.d.ts +2 -2
- package/dist-types/commands/DeleteSegmentSubscriptionCommand.d.ts +88 -0
- package/dist-types/commands/DisassociateStreamForSegmentsCommand.d.ts +87 -0
- package/dist-types/commands/GetCalculatedAttributeDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/GetSegmentDefinitionCommand.d.ts +2 -2
- package/dist-types/commands/GetSegmentSubscriptionCommand.d.ts +99 -0
- package/dist-types/commands/GetStreamForSegmentsCommand.d.ts +100 -0
- package/dist-types/commands/ListProfileObjectTypeTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListRecommenderFiltersCommand.d.ts +1 -1
- package/dist-types/commands/ListRecommenderRecipesCommand.d.ts +1 -1
- package/dist-types/commands/ListRecommenderSchemasCommand.d.ts +1 -2
- package/dist-types/commands/ListRecommendersCommand.d.ts +1 -1
- package/dist-types/commands/ListSegmentSubscriptionEventsCommand.d.ts +99 -0
- package/dist-types/commands/PutSegmentSubscriptionCommand.d.ts +107 -0
- package/dist-types/commands/UpdateCalculatedAttributeDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/enums.d.ts +79 -0
- package/dist-types/models/models_0.d.ts +335 -300
- package/dist-types/models/models_1.d.ts +446 -2
- package/dist-types/pagination/ListSegmentSubscriptionEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +25 -0
- package/dist-types/ts3.4/CustomerProfiles.d.ts +126 -0
- package/dist-types/ts3.4/CustomerProfilesClient.d.ts +42 -0
- package/dist-types/ts3.4/commands/AssociateStreamForSegmentsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteSegmentSubscriptionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DisassociateStreamForSegmentsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetSegmentSubscriptionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetStreamForSegmentsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListProfileObjectTypeTemplatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRecommenderFiltersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRecommenderRecipesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRecommenderSchemasCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/ListRecommendersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSegmentSubscriptionEventsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/PutSegmentSubscriptionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/models/enums.d.ts +42 -0
- package/dist-types/ts3.4/models/models_0.d.ts +61 -71
- package/dist-types/ts3.4/models/models_1.d.ts +105 -0
- package/dist-types/ts3.4/pagination/ListSegmentSubscriptionEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +25 -0
- package/package.json +1 -1
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { GetStreamForSegmentsRequest, GetStreamForSegmentsResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link GetStreamForSegmentsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetStreamForSegmentsCommandInput extends GetStreamForSegmentsRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link GetStreamForSegmentsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface GetStreamForSegmentsCommandOutput extends GetStreamForSegmentsResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const GetStreamForSegmentsCommand_base: {
|
|
22
|
+
new (input: GetStreamForSegmentsCommandInput): import("@smithy/core/client").CommandImpl<GetStreamForSegmentsCommandInput, GetStreamForSegmentsCommandOutput, import("..").CustomerProfilesClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: GetStreamForSegmentsCommandInput): import("@smithy/core/client").CommandImpl<GetStreamForSegmentsCommandInput, GetStreamForSegmentsCommandOutput, import("..").CustomerProfilesClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Returns information about the segment membership event stream configured for a specific
|
|
28
|
+
* domain, including the stream state and associated segments. </p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { CustomerProfilesClient, GetStreamForSegmentsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
33
|
+
* // const { CustomerProfilesClient, GetStreamForSegmentsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
|
|
34
|
+
* // import type { CustomerProfilesClientConfig } from "@aws-sdk/client-customer-profiles";
|
|
35
|
+
* const config = {}; // type is CustomerProfilesClientConfig
|
|
36
|
+
* const client = new CustomerProfilesClient(config);
|
|
37
|
+
* const input = { // GetStreamForSegmentsRequest
|
|
38
|
+
* DomainName: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetStreamForSegmentsCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetStreamForSegmentsResponse
|
|
43
|
+
* // AssociatedAt: new Date("TIMESTAMP"),
|
|
44
|
+
* // AssociatedSegments: [ // AssociatedSegmentsList
|
|
45
|
+
* // { // AssociatedSegment
|
|
46
|
+
* // SegmentName: "STRING_VALUE",
|
|
47
|
+
* // Status: "STARTING" || "RUNNING" || "STOPPED" || "FAILED",
|
|
48
|
+
* // Message: "STRING_VALUE",
|
|
49
|
+
* // },
|
|
50
|
+
* // ],
|
|
51
|
+
* // DomainName: "STRING_VALUE",
|
|
52
|
+
* // DestinationArn: "STRING_VALUE",
|
|
53
|
+
* // DestinationRoleArn: "STRING_VALUE",
|
|
54
|
+
* // State: "RUNNING" || "UNHEALTHY" || "STOPPED",
|
|
55
|
+
* // DisassociatedAt: new Date("TIMESTAMP"),
|
|
56
|
+
* // FailureReason: "STRING_VALUE",
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
61
|
+
* @param GetStreamForSegmentsCommandInput - {@link GetStreamForSegmentsCommandInput}
|
|
62
|
+
* @returns {@link GetStreamForSegmentsCommandOutput}
|
|
63
|
+
* @see {@link GetStreamForSegmentsCommandInput} for command's `input` shape.
|
|
64
|
+
* @see {@link GetStreamForSegmentsCommandOutput} for command's `response` shape.
|
|
65
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
68
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link BadRequestException} (client fault)
|
|
71
|
+
* <p>The input you provided is invalid.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InternalServerException} (server fault)
|
|
74
|
+
* <p>An internal service error occurred.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
80
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export declare class GetStreamForSegmentsCommand extends GetStreamForSegmentsCommand_base {
|
|
89
|
+
/** @internal type navigation helper, not in runtime. */
|
|
90
|
+
protected static __types: {
|
|
91
|
+
api: {
|
|
92
|
+
input: GetStreamForSegmentsRequest;
|
|
93
|
+
output: GetStreamForSegmentsResponse;
|
|
94
|
+
};
|
|
95
|
+
sdk: {
|
|
96
|
+
input: GetStreamForSegmentsCommandInput;
|
|
97
|
+
output: GetStreamForSegmentsCommandOutput;
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { ListProfileObjectTypeTemplatesRequest, ListProfileObjectTypeTemplatesResponse } from "../models/
|
|
2
|
+
import type { ListProfileObjectTypeTemplatesRequest, ListProfileObjectTypeTemplatesResponse } from "../models/models_1";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { ListRecommenderFiltersRequest, ListRecommenderFiltersResponse } from "../models/
|
|
2
|
+
import type { ListRecommenderFiltersRequest, ListRecommenderFiltersResponse } from "../models/models_1";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { ListRecommenderRecipesRequest, ListRecommenderRecipesResponse } from "../models/
|
|
2
|
+
import type { ListRecommenderRecipesRequest, ListRecommenderRecipesResponse } from "../models/models_1";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { ListRecommenderSchemasRequest } from "../models/
|
|
3
|
-
import type { ListRecommenderSchemasResponse } from "../models/models_1";
|
|
2
|
+
import type { ListRecommenderSchemasRequest, ListRecommenderSchemasResponse } from "../models/models_1";
|
|
4
3
|
/**
|
|
5
4
|
* @public
|
|
6
5
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { ListRecommendersRequest, ListRecommendersResponse } from "../models/
|
|
2
|
+
import type { ListRecommendersRequest, ListRecommendersResponse } from "../models/models_1";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListSegmentSubscriptionEventsRequest, ListSegmentSubscriptionEventsResponse } from "../models/models_1";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListSegmentSubscriptionEventsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListSegmentSubscriptionEventsCommandInput extends ListSegmentSubscriptionEventsRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListSegmentSubscriptionEventsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListSegmentSubscriptionEventsCommandOutput extends ListSegmentSubscriptionEventsResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListSegmentSubscriptionEventsCommand_base: {
|
|
22
|
+
new (input: ListSegmentSubscriptionEventsCommandInput): import("@smithy/core/client").CommandImpl<ListSegmentSubscriptionEventsCommandInput, ListSegmentSubscriptionEventsCommandOutput, import("..").CustomerProfilesClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: ListSegmentSubscriptionEventsCommandInput): import("@smithy/core/client").CommandImpl<ListSegmentSubscriptionEventsCommandInput, ListSegmentSubscriptionEventsCommandOutput, import("..").CustomerProfilesClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Returns the most recent membership events for a segment. Each event represents a profile
|
|
28
|
+
* that entered or exited the segment. </p>
|
|
29
|
+
* <p>This operation is paginated. </p>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { CustomerProfilesClient, ListSegmentSubscriptionEventsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
34
|
+
* // const { CustomerProfilesClient, ListSegmentSubscriptionEventsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
|
|
35
|
+
* // import type { CustomerProfilesClientConfig } from "@aws-sdk/client-customer-profiles";
|
|
36
|
+
* const config = {}; // type is CustomerProfilesClientConfig
|
|
37
|
+
* const client = new CustomerProfilesClient(config);
|
|
38
|
+
* const input = { // ListSegmentSubscriptionEventsRequest
|
|
39
|
+
* DomainName: "STRING_VALUE", // required
|
|
40
|
+
* SegmentDefinitionName: "STRING_VALUE", // required
|
|
41
|
+
* MaxResults: Number("int"),
|
|
42
|
+
* NextToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new ListSegmentSubscriptionEventsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // ListSegmentSubscriptionEventsResponse
|
|
47
|
+
* // Events: [ // SubscriptionEventsList
|
|
48
|
+
* // { // SubscriptionEventItem
|
|
49
|
+
* // ProfileId: "STRING_VALUE",
|
|
50
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
51
|
+
* // EventType: "LIVE" || "SCHEDULE",
|
|
52
|
+
* // Event: "JOINED" || "LEFT",
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // NextToken: "STRING_VALUE",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param ListSegmentSubscriptionEventsCommandInput - {@link ListSegmentSubscriptionEventsCommandInput}
|
|
61
|
+
* @returns {@link ListSegmentSubscriptionEventsCommandOutput}
|
|
62
|
+
* @see {@link ListSegmentSubscriptionEventsCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link ListSegmentSubscriptionEventsCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
67
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link BadRequestException} (client fault)
|
|
70
|
+
* <p>The input you provided is invalid.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InternalServerException} (server fault)
|
|
73
|
+
* <p>An internal service error occurred.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
79
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
83
|
+
*
|
|
84
|
+
*
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
export declare class ListSegmentSubscriptionEventsCommand extends ListSegmentSubscriptionEventsCommand_base {
|
|
88
|
+
/** @internal type navigation helper, not in runtime. */
|
|
89
|
+
protected static __types: {
|
|
90
|
+
api: {
|
|
91
|
+
input: ListSegmentSubscriptionEventsRequest;
|
|
92
|
+
output: ListSegmentSubscriptionEventsResponse;
|
|
93
|
+
};
|
|
94
|
+
sdk: {
|
|
95
|
+
input: ListSegmentSubscriptionEventsCommandInput;
|
|
96
|
+
output: ListSegmentSubscriptionEventsCommandOutput;
|
|
97
|
+
};
|
|
98
|
+
};
|
|
99
|
+
}
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { PutSegmentSubscriptionRequest, PutSegmentSubscriptionResponse } from "../models/models_1";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link PutSegmentSubscriptionCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface PutSegmentSubscriptionCommandInput extends PutSegmentSubscriptionRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link PutSegmentSubscriptionCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface PutSegmentSubscriptionCommandOutput extends PutSegmentSubscriptionResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const PutSegmentSubscriptionCommand_base: {
|
|
22
|
+
new (input: PutSegmentSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<PutSegmentSubscriptionCommandInput, PutSegmentSubscriptionCommandOutput, import("..").CustomerProfilesClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: PutSegmentSubscriptionCommandInput): import("@smithy/core/client").CommandImpl<PutSegmentSubscriptionCommandInput, PutSegmentSubscriptionCommandOutput, import("..").CustomerProfilesClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Creates or updates a segment subscription for membership events. When a subscription is
|
|
28
|
+
* created, an initial snapshot is taken and the system begins monitoring for membership
|
|
29
|
+
* changes. </p>
|
|
30
|
+
* <p>You can optionally set a schedule configuration interval to control how often membership
|
|
31
|
+
* snapshots are run. The interval can be from 1 to 24 hours. If not set, the interval defaults
|
|
32
|
+
* to 24 hours. Scheduled snapshots run on
|
|
33
|
+
* a best-effort basis. If a scheduled snapshot takes longer than the configured interval, the
|
|
34
|
+
* next scheduled run does not start until the in-progress snapshot completes, so a run might
|
|
35
|
+
* be delayed or skipped and is not guaranteed to occur at exactly the requested time. </p>
|
|
36
|
+
* <p>For Classic segments, membership events are generated from these scheduled snapshots and
|
|
37
|
+
* also in near real-time as profile attribute changes occur. For SQL segments, membership
|
|
38
|
+
* events are generated only from the scheduled snapshots. </p>
|
|
39
|
+
* @example
|
|
40
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
41
|
+
* ```javascript
|
|
42
|
+
* import { CustomerProfilesClient, PutSegmentSubscriptionCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
|
|
43
|
+
* // const { CustomerProfilesClient, PutSegmentSubscriptionCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
|
|
44
|
+
* // import type { CustomerProfilesClientConfig } from "@aws-sdk/client-customer-profiles";
|
|
45
|
+
* const config = {}; // type is CustomerProfilesClientConfig
|
|
46
|
+
* const client = new CustomerProfilesClient(config);
|
|
47
|
+
* const input = { // PutSegmentSubscriptionRequest
|
|
48
|
+
* DomainName: "STRING_VALUE", // required
|
|
49
|
+
* SegmentDefinitionName: "STRING_VALUE", // required
|
|
50
|
+
* ScheduleConfiguration: { // ScheduleConfiguration
|
|
51
|
+
* Interval: Number("int"), // required
|
|
52
|
+
* Unit: "HOURLY",
|
|
53
|
+
* },
|
|
54
|
+
* };
|
|
55
|
+
* const command = new PutSegmentSubscriptionCommand(input);
|
|
56
|
+
* const response = await client.send(command);
|
|
57
|
+
* // { // PutSegmentSubscriptionResponse
|
|
58
|
+
* // Status: "STARTING" || "RUNNING" || "STOPPED" || "FAILED",
|
|
59
|
+
* // ScheduleConfiguration: { // ScheduleConfiguration
|
|
60
|
+
* // Interval: Number("int"), // required
|
|
61
|
+
* // Unit: "HOURLY",
|
|
62
|
+
* // },
|
|
63
|
+
* // StartedAt: new Date("TIMESTAMP"),
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param PutSegmentSubscriptionCommandInput - {@link PutSegmentSubscriptionCommandInput}
|
|
69
|
+
* @returns {@link PutSegmentSubscriptionCommandOutput}
|
|
70
|
+
* @see {@link PutSegmentSubscriptionCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link PutSegmentSubscriptionCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link BadRequestException} (client fault)
|
|
78
|
+
* <p>The input you provided is invalid.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalServerException} (server fault)
|
|
81
|
+
* <p>An internal service error occurred.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>The requested resource does not exist, or access was denied.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
87
|
+
* <p>You exceeded the maximum number of requests.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link CustomerProfilesServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
|
|
91
|
+
*
|
|
92
|
+
*
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
export declare class PutSegmentSubscriptionCommand extends PutSegmentSubscriptionCommand_base {
|
|
96
|
+
/** @internal type navigation helper, not in runtime. */
|
|
97
|
+
protected static __types: {
|
|
98
|
+
api: {
|
|
99
|
+
input: PutSegmentSubscriptionRequest;
|
|
100
|
+
output: PutSegmentSubscriptionResponse;
|
|
101
|
+
};
|
|
102
|
+
sdk: {
|
|
103
|
+
input: PutSegmentSubscriptionCommandInput;
|
|
104
|
+
output: PutSegmentSubscriptionCommandOutput;
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
}
|
|
@@ -66,7 +66,7 @@ declare const UpdateCalculatedAttributeDefinitionCommand_base: {
|
|
|
66
66
|
* // Description: "STRING_VALUE",
|
|
67
67
|
* // CreatedAt: new Date("TIMESTAMP"),
|
|
68
68
|
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
69
|
-
* // Statistic: "FIRST_OCCURRENCE" || "LAST_OCCURRENCE" || "COUNT" || "SUM" || "MINIMUM" || "MAXIMUM" || "AVERAGE" || "MAX_OCCURRENCE",
|
|
69
|
+
* // Statistic: "FIRST_OCCURRENCE" || "LAST_OCCURRENCE" || "COUNT" || "SUM" || "MINIMUM" || "MAXIMUM" || "AVERAGE" || "MAX_OCCURRENCE" || "RECENT_OCCURRENCES",
|
|
70
70
|
* // Conditions: { // Conditions
|
|
71
71
|
* // Range: { // Range
|
|
72
72
|
* // Value: Number("int"),
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export * from "./AddProfileKeyCommand";
|
|
2
|
+
export * from "./AssociateStreamForSegmentsCommand";
|
|
2
3
|
export * from "./BatchGetCalculatedAttributeForProfileCommand";
|
|
3
4
|
export * from "./BatchGetProfileCommand";
|
|
4
5
|
export * from "./BatchPutProfileObjectCommand";
|
|
@@ -31,8 +32,10 @@ export * from "./DeleteRecommenderCommand";
|
|
|
31
32
|
export * from "./DeleteRecommenderFilterCommand";
|
|
32
33
|
export * from "./DeleteRecommenderSchemaCommand";
|
|
33
34
|
export * from "./DeleteSegmentDefinitionCommand";
|
|
35
|
+
export * from "./DeleteSegmentSubscriptionCommand";
|
|
34
36
|
export * from "./DeleteWorkflowCommand";
|
|
35
37
|
export * from "./DetectProfileObjectTypeCommand";
|
|
38
|
+
export * from "./DisassociateStreamForSegmentsCommand";
|
|
36
39
|
export * from "./GetAutoMergingPreviewCommand";
|
|
37
40
|
export * from "./GetCalculatedAttributeDefinitionCommand";
|
|
38
41
|
export * from "./GetCalculatedAttributeForProfileCommand";
|
|
@@ -56,7 +59,9 @@ export * from "./GetSegmentDefinitionCommand";
|
|
|
56
59
|
export * from "./GetSegmentEstimateCommand";
|
|
57
60
|
export * from "./GetSegmentMembershipCommand";
|
|
58
61
|
export * from "./GetSegmentSnapshotCommand";
|
|
62
|
+
export * from "./GetSegmentSubscriptionCommand";
|
|
59
63
|
export * from "./GetSimilarProfilesCommand";
|
|
64
|
+
export * from "./GetStreamForSegmentsCommand";
|
|
60
65
|
export * from "./GetUploadJobCommand";
|
|
61
66
|
export * from "./GetUploadJobPathCommand";
|
|
62
67
|
export * from "./GetWorkflowCommand";
|
|
@@ -84,6 +89,7 @@ export * from "./ListRecommenderSchemasCommand";
|
|
|
84
89
|
export * from "./ListRecommendersCommand";
|
|
85
90
|
export * from "./ListRuleBasedMatchesCommand";
|
|
86
91
|
export * from "./ListSegmentDefinitionsCommand";
|
|
92
|
+
export * from "./ListSegmentSubscriptionEventsCommand";
|
|
87
93
|
export * from "./ListTagsForResourceCommand";
|
|
88
94
|
export * from "./ListUploadJobsCommand";
|
|
89
95
|
export * from "./ListWorkflowsCommand";
|
|
@@ -92,6 +98,7 @@ export * from "./PutDomainObjectTypeCommand";
|
|
|
92
98
|
export * from "./PutIntegrationCommand";
|
|
93
99
|
export * from "./PutProfileObjectCommand";
|
|
94
100
|
export * from "./PutProfileObjectTypeCommand";
|
|
101
|
+
export * from "./PutSegmentSubscriptionCommand";
|
|
95
102
|
export * from "./SearchProfilesCommand";
|
|
96
103
|
export * from "./StartRecommenderCommand";
|
|
97
104
|
export * from "./StartUploadJobCommand";
|
|
@@ -272,6 +272,20 @@ export declare const Status: {
|
|
|
272
272
|
* @public
|
|
273
273
|
*/
|
|
274
274
|
export type Status = (typeof Status)[keyof typeof Status];
|
|
275
|
+
/**
|
|
276
|
+
* @public
|
|
277
|
+
* @enum
|
|
278
|
+
*/
|
|
279
|
+
export declare const EventSubscriptionSegmentStatus: {
|
|
280
|
+
readonly FAILED: "FAILED";
|
|
281
|
+
readonly RUNNING: "RUNNING";
|
|
282
|
+
readonly STARTING: "STARTING";
|
|
283
|
+
readonly STOPPED: "STOPPED";
|
|
284
|
+
};
|
|
285
|
+
/**
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
export type EventSubscriptionSegmentStatus = (typeof EventSubscriptionSegmentStatus)[keyof typeof EventSubscriptionSegmentStatus];
|
|
275
289
|
/**
|
|
276
290
|
* @public
|
|
277
291
|
* @enum
|
|
@@ -290,6 +304,8 @@ export declare const AttributeDimensionType: {
|
|
|
290
304
|
readonly INCLUSIVE: "INCLUSIVE";
|
|
291
305
|
readonly LESS_THAN: "LESS_THAN";
|
|
292
306
|
readonly LESS_THAN_OR_EQUAL: "LESS_THAN_OR_EQUAL";
|
|
307
|
+
readonly LIST_CONTAINS: "LIST_CONTAINS";
|
|
308
|
+
readonly LIST_CONTAINS_ALL: "LIST_CONTAINS_ALL";
|
|
293
309
|
readonly NOT_BETWEEN: "NOT_BETWEEN";
|
|
294
310
|
readonly ON: "ON";
|
|
295
311
|
};
|
|
@@ -526,6 +542,7 @@ export declare const Statistic: {
|
|
|
526
542
|
readonly MAXIMUM: "MAXIMUM";
|
|
527
543
|
readonly MAX_OCCURRENCE: "MAX_OCCURRENCE";
|
|
528
544
|
readonly MINIMUM: "MINIMUM";
|
|
545
|
+
readonly RECENT_OCCURRENCES: "RECENT_OCCURRENCES";
|
|
529
546
|
readonly SUM: "SUM";
|
|
530
547
|
};
|
|
531
548
|
/**
|
|
@@ -958,6 +975,31 @@ export declare const SegmentSnapshotStatus: {
|
|
|
958
975
|
* @public
|
|
959
976
|
*/
|
|
960
977
|
export type SegmentSnapshotStatus = (typeof SegmentSnapshotStatus)[keyof typeof SegmentSnapshotStatus];
|
|
978
|
+
/**
|
|
979
|
+
* @public
|
|
980
|
+
* @enum
|
|
981
|
+
*/
|
|
982
|
+
export declare const ScheduleConfigurationUnit: {
|
|
983
|
+
readonly HOURLY: "HOURLY";
|
|
984
|
+
};
|
|
985
|
+
/**
|
|
986
|
+
* @public
|
|
987
|
+
*/
|
|
988
|
+
export type ScheduleConfigurationUnit = (typeof ScheduleConfigurationUnit)[keyof typeof ScheduleConfigurationUnit];
|
|
989
|
+
/**
|
|
990
|
+
* @public
|
|
991
|
+
* @enum
|
|
992
|
+
*/
|
|
993
|
+
export declare const SegmentSubscriptionStatus: {
|
|
994
|
+
readonly FAILED: "FAILED";
|
|
995
|
+
readonly RUNNING: "RUNNING";
|
|
996
|
+
readonly STARTING: "STARTING";
|
|
997
|
+
readonly STOPPED: "STOPPED";
|
|
998
|
+
};
|
|
999
|
+
/**
|
|
1000
|
+
* @public
|
|
1001
|
+
*/
|
|
1002
|
+
export type SegmentSubscriptionStatus = (typeof SegmentSubscriptionStatus)[keyof typeof SegmentSubscriptionStatus];
|
|
961
1003
|
/**
|
|
962
1004
|
* @public
|
|
963
1005
|
* @enum
|
|
@@ -970,6 +1012,19 @@ export declare const MatchType: {
|
|
|
970
1012
|
* @public
|
|
971
1013
|
*/
|
|
972
1014
|
export type MatchType = (typeof MatchType)[keyof typeof MatchType];
|
|
1015
|
+
/**
|
|
1016
|
+
* @public
|
|
1017
|
+
* @enum
|
|
1018
|
+
*/
|
|
1019
|
+
export declare const EventSubscriptionState: {
|
|
1020
|
+
readonly RUNNING: "RUNNING";
|
|
1021
|
+
readonly STOPPED: "STOPPED";
|
|
1022
|
+
readonly UNHEALTHY: "UNHEALTHY";
|
|
1023
|
+
};
|
|
1024
|
+
/**
|
|
1025
|
+
* @public
|
|
1026
|
+
*/
|
|
1027
|
+
export type EventSubscriptionState = (typeof EventSubscriptionState)[keyof typeof EventSubscriptionState];
|
|
973
1028
|
/**
|
|
974
1029
|
* @public
|
|
975
1030
|
* @enum
|
|
@@ -998,6 +1053,30 @@ export declare const StatusReason: {
|
|
|
998
1053
|
* @public
|
|
999
1054
|
*/
|
|
1000
1055
|
export type StatusReason = (typeof StatusReason)[keyof typeof StatusReason];
|
|
1056
|
+
/**
|
|
1057
|
+
* @public
|
|
1058
|
+
* @enum
|
|
1059
|
+
*/
|
|
1060
|
+
export declare const SubscriptionEvent: {
|
|
1061
|
+
readonly JOINED: "JOINED";
|
|
1062
|
+
readonly LEFT: "LEFT";
|
|
1063
|
+
};
|
|
1064
|
+
/**
|
|
1065
|
+
* @public
|
|
1066
|
+
*/
|
|
1067
|
+
export type SubscriptionEvent = (typeof SubscriptionEvent)[keyof typeof SubscriptionEvent];
|
|
1068
|
+
/**
|
|
1069
|
+
* @public
|
|
1070
|
+
* @enum
|
|
1071
|
+
*/
|
|
1072
|
+
export declare const SubscriptionEventType: {
|
|
1073
|
+
readonly LIVE: "LIVE";
|
|
1074
|
+
readonly SCHEDULE: "SCHEDULE";
|
|
1075
|
+
};
|
|
1076
|
+
/**
|
|
1077
|
+
* @public
|
|
1078
|
+
*/
|
|
1079
|
+
export type SubscriptionEventType = (typeof SubscriptionEventType)[keyof typeof SubscriptionEventType];
|
|
1001
1080
|
/**
|
|
1002
1081
|
* @public
|
|
1003
1082
|
* @enum
|