@aws-sdk/client-customer-profiles 3.321.1 → 3.326.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.
Files changed (39) hide show
  1. package/dist-types/commands/AddProfileKeyCommand.d.ts +9 -0
  2. package/dist-types/commands/CreateDomainCommand.d.ts +42 -0
  3. package/dist-types/commands/CreateIntegrationWorkflowCommand.d.ts +7 -0
  4. package/dist-types/commands/CreateProfileCommand.d.ts +6 -0
  5. package/dist-types/commands/DeleteDomainCommand.d.ts +6 -0
  6. package/dist-types/commands/DeleteIntegrationCommand.d.ts +6 -0
  7. package/dist-types/commands/DeleteProfileCommand.d.ts +6 -0
  8. package/dist-types/commands/DeleteProfileKeyCommand.d.ts +6 -0
  9. package/dist-types/commands/DeleteProfileObjectCommand.d.ts +6 -0
  10. package/dist-types/commands/DeleteProfileObjectTypeCommand.d.ts +6 -0
  11. package/dist-types/commands/DeleteWorkflowCommand.d.ts +4 -0
  12. package/dist-types/commands/GetAutoMergingPreviewCommand.d.ts +9 -0
  13. package/dist-types/commands/GetDomainCommand.d.ts +48 -0
  14. package/dist-types/commands/GetIdentityResolutionJobCommand.d.ts +39 -0
  15. package/dist-types/commands/GetIntegrationCommand.d.ts +18 -0
  16. package/dist-types/commands/GetMatchesCommand.d.ts +17 -0
  17. package/dist-types/commands/GetProfileObjectTypeCommand.d.ts +36 -0
  18. package/dist-types/commands/GetProfileObjectTypeTemplateCommand.d.ts +29 -0
  19. package/dist-types/commands/GetWorkflowCommand.d.ts +25 -0
  20. package/dist-types/commands/GetWorkflowStepsCommand.d.ts +22 -0
  21. package/dist-types/commands/ListAccountIntegrationsCommand.d.ts +23 -0
  22. package/dist-types/commands/ListDomainsCommand.d.ts +16 -0
  23. package/dist-types/commands/ListIdentityResolutionJobsCommand.d.ts +27 -0
  24. package/dist-types/commands/ListIntegrationsCommand.d.ts +23 -0
  25. package/dist-types/commands/ListProfileObjectTypeTemplatesCommand.d.ts +13 -0
  26. package/dist-types/commands/ListProfileObjectTypesCommand.d.ts +17 -0
  27. package/dist-types/commands/ListProfileObjectsCommand.d.ts +13 -0
  28. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  29. package/dist-types/commands/ListWorkflowsCommand.d.ts +16 -0
  30. package/dist-types/commands/MergeProfilesCommand.d.ts +6 -0
  31. package/dist-types/commands/PutIntegrationCommand.d.ts +18 -0
  32. package/dist-types/commands/PutProfileObjectCommand.d.ts +6 -0
  33. package/dist-types/commands/PutProfileObjectTypeCommand.d.ts +36 -0
  34. package/dist-types/commands/SearchProfilesCommand.d.ts +88 -0
  35. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  36. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  37. package/dist-types/commands/UpdateDomainCommand.d.ts +42 -0
  38. package/dist-types/commands/UpdateProfileCommand.d.ts +6 -0
  39. package/package.json +16 -16
@@ -39,6 +39,13 @@ export interface AddProfileKeyCommandOutput extends AddProfileKeyResponse, __Met
39
39
  * };
40
40
  * const command = new AddProfileKeyCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // AddProfileKeyResponse
43
+ * // KeyName: "STRING_VALUE",
44
+ * // Values: [ // requestValueList
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // };
48
+ *
42
49
  * ```
43
50
  *
44
51
  * @param AddProfileKeyCommandInput - {@link AddProfileKeyCommandInput}
@@ -62,6 +69,8 @@ export interface AddProfileKeyCommandOutput extends AddProfileKeyResponse, __Met
62
69
  * @throws {@link ThrottlingException} (client fault)
63
70
  * <p>You exceeded the maximum number of requests.</p>
64
71
  *
72
+ * @throws {@link CustomerProfilesServiceException}
73
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
65
74
  *
66
75
  */
67
76
  export declare class AddProfileKeyCommand extends $Command<AddProfileKeyCommandInput, AddProfileKeyCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -74,6 +74,46 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
74
74
  * };
75
75
  * const command = new CreateDomainCommand(input);
76
76
  * const response = await client.send(command);
77
+ * // { // CreateDomainResponse
78
+ * // DomainName: "STRING_VALUE", // required
79
+ * // DefaultExpirationDays: Number("int"), // required
80
+ * // DefaultEncryptionKey: "STRING_VALUE",
81
+ * // DeadLetterQueueUrl: "STRING_VALUE",
82
+ * // Matching: { // MatchingResponse
83
+ * // Enabled: true || false,
84
+ * // JobSchedule: { // JobSchedule
85
+ * // DayOfTheWeek: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", // required
86
+ * // Time: "STRING_VALUE", // required
87
+ * // },
88
+ * // AutoMerging: { // AutoMerging
89
+ * // Enabled: true || false, // required
90
+ * // Consolidation: { // Consolidation
91
+ * // MatchingAttributesList: [ // MatchingAttributesList // required
92
+ * // [ // MatchingAttributes
93
+ * // "STRING_VALUE",
94
+ * // ],
95
+ * // ],
96
+ * // },
97
+ * // ConflictResolution: { // ConflictResolution
98
+ * // ConflictResolvingModel: "RECENCY" || "SOURCE", // required
99
+ * // SourceName: "STRING_VALUE",
100
+ * // },
101
+ * // MinAllowedConfidenceScoreForMerging: Number("double"),
102
+ * // },
103
+ * // ExportingConfig: { // ExportingConfig
104
+ * // S3Exporting: { // S3ExportingConfig
105
+ * // S3BucketName: "STRING_VALUE", // required
106
+ * // S3KeyName: "STRING_VALUE",
107
+ * // },
108
+ * // },
109
+ * // },
110
+ * // CreatedAt: new Date("TIMESTAMP"), // required
111
+ * // LastUpdatedAt: new Date("TIMESTAMP"), // required
112
+ * // Tags: { // TagMap
113
+ * // "<keys>": "STRING_VALUE",
114
+ * // },
115
+ * // };
116
+ *
77
117
  * ```
78
118
  *
79
119
  * @param CreateDomainCommandInput - {@link CreateDomainCommandInput}
@@ -97,6 +137,8 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
97
137
  * @throws {@link ThrottlingException} (client fault)
98
138
  * <p>You exceeded the maximum number of requests.</p>
99
139
  *
140
+ * @throws {@link CustomerProfilesServiceException}
141
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
100
142
  *
101
143
  */
102
144
  export declare class CreateDomainCommand extends $Command<CreateDomainCommandInput, CreateDomainCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -114,6 +114,11 @@ export interface CreateIntegrationWorkflowCommandOutput extends CreateIntegratio
114
114
  * };
115
115
  * const command = new CreateIntegrationWorkflowCommand(input);
116
116
  * const response = await client.send(command);
117
+ * // { // CreateIntegrationWorkflowResponse
118
+ * // WorkflowId: "STRING_VALUE", // required
119
+ * // Message: "STRING_VALUE", // required
120
+ * // };
121
+ *
117
122
  * ```
118
123
  *
119
124
  * @param CreateIntegrationWorkflowCommandInput - {@link CreateIntegrationWorkflowCommandInput}
@@ -137,6 +142,8 @@ export interface CreateIntegrationWorkflowCommandOutput extends CreateIntegratio
137
142
  * @throws {@link ThrottlingException} (client fault)
138
143
  * <p>You exceeded the maximum number of requests.</p>
139
144
  *
145
+ * @throws {@link CustomerProfilesServiceException}
146
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
140
147
  *
141
148
  */
142
149
  export declare class CreateIntegrationWorkflowCommand extends $Command<CreateIntegrationWorkflowCommandInput, CreateIntegrationWorkflowCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -102,6 +102,10 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
102
102
  * };
103
103
  * const command = new CreateProfileCommand(input);
104
104
  * const response = await client.send(command);
105
+ * // { // CreateProfileResponse
106
+ * // ProfileId: "STRING_VALUE", // required
107
+ * // };
108
+ *
105
109
  * ```
106
110
  *
107
111
  * @param CreateProfileCommandInput - {@link CreateProfileCommandInput}
@@ -125,6 +129,8 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
125
129
  * @throws {@link ThrottlingException} (client fault)
126
130
  * <p>You exceeded the maximum number of requests.</p>
127
131
  *
132
+ * @throws {@link CustomerProfilesServiceException}
133
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
128
134
  *
129
135
  */
130
136
  export declare class CreateProfileCommand extends $Command<CreateProfileCommandInput, CreateProfileCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -32,6 +32,10 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
32
32
  * };
33
33
  * const command = new DeleteDomainCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeleteDomainResponse
36
+ * // Message: "STRING_VALUE", // required
37
+ * // };
38
+ *
35
39
  * ```
36
40
  *
37
41
  * @param DeleteDomainCommandInput - {@link DeleteDomainCommandInput}
@@ -55,6 +59,8 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
55
59
  * @throws {@link ThrottlingException} (client fault)
56
60
  * <p>You exceeded the maximum number of requests.</p>
57
61
  *
62
+ * @throws {@link CustomerProfilesServiceException}
63
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
58
64
  *
59
65
  */
60
66
  export declare class DeleteDomainCommand extends $Command<DeleteDomainCommandInput, DeleteDomainCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -32,6 +32,10 @@ export interface DeleteIntegrationCommandOutput extends DeleteIntegrationRespons
32
32
  * };
33
33
  * const command = new DeleteIntegrationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeleteIntegrationResponse
36
+ * // Message: "STRING_VALUE", // required
37
+ * // };
38
+ *
35
39
  * ```
36
40
  *
37
41
  * @param DeleteIntegrationCommandInput - {@link DeleteIntegrationCommandInput}
@@ -55,6 +59,8 @@ export interface DeleteIntegrationCommandOutput extends DeleteIntegrationRespons
55
59
  * @throws {@link ThrottlingException} (client fault)
56
60
  * <p>You exceeded the maximum number of requests.</p>
57
61
  *
62
+ * @throws {@link CustomerProfilesServiceException}
63
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
58
64
  *
59
65
  */
60
66
  export declare class DeleteIntegrationCommand extends $Command<DeleteIntegrationCommandInput, DeleteIntegrationCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -32,6 +32,10 @@ export interface DeleteProfileCommandOutput extends DeleteProfileResponse, __Met
32
32
  * };
33
33
  * const command = new DeleteProfileCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeleteProfileResponse
36
+ * // Message: "STRING_VALUE",
37
+ * // };
38
+ *
35
39
  * ```
36
40
  *
37
41
  * @param DeleteProfileCommandInput - {@link DeleteProfileCommandInput}
@@ -55,6 +59,8 @@ export interface DeleteProfileCommandOutput extends DeleteProfileResponse, __Met
55
59
  * @throws {@link ThrottlingException} (client fault)
56
60
  * <p>You exceeded the maximum number of requests.</p>
57
61
  *
62
+ * @throws {@link CustomerProfilesServiceException}
63
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
58
64
  *
59
65
  */
60
66
  export declare class DeleteProfileCommand extends $Command<DeleteProfileCommandInput, DeleteProfileCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -36,6 +36,10 @@ export interface DeleteProfileKeyCommandOutput extends DeleteProfileKeyResponse,
36
36
  * };
37
37
  * const command = new DeleteProfileKeyCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DeleteProfileKeyResponse
40
+ * // Message: "STRING_VALUE",
41
+ * // };
42
+ *
39
43
  * ```
40
44
  *
41
45
  * @param DeleteProfileKeyCommandInput - {@link DeleteProfileKeyCommandInput}
@@ -59,6 +63,8 @@ export interface DeleteProfileKeyCommandOutput extends DeleteProfileKeyResponse,
59
63
  * @throws {@link ThrottlingException} (client fault)
60
64
  * <p>You exceeded the maximum number of requests.</p>
61
65
  *
66
+ * @throws {@link CustomerProfilesServiceException}
67
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
62
68
  *
63
69
  */
64
70
  export declare class DeleteProfileKeyCommand extends $Command<DeleteProfileKeyCommandInput, DeleteProfileKeyCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -34,6 +34,10 @@ export interface DeleteProfileObjectCommandOutput extends DeleteProfileObjectRes
34
34
  * };
35
35
  * const command = new DeleteProfileObjectCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DeleteProfileObjectResponse
38
+ * // Message: "STRING_VALUE",
39
+ * // };
40
+ *
37
41
  * ```
38
42
  *
39
43
  * @param DeleteProfileObjectCommandInput - {@link DeleteProfileObjectCommandInput}
@@ -57,6 +61,8 @@ export interface DeleteProfileObjectCommandOutput extends DeleteProfileObjectRes
57
61
  * @throws {@link ThrottlingException} (client fault)
58
62
  * <p>You exceeded the maximum number of requests.</p>
59
63
  *
64
+ * @throws {@link CustomerProfilesServiceException}
65
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
60
66
  *
61
67
  */
62
68
  export declare class DeleteProfileObjectCommand extends $Command<DeleteProfileObjectCommandInput, DeleteProfileObjectCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -35,6 +35,10 @@ export interface DeleteProfileObjectTypeCommandOutput extends DeleteProfileObjec
35
35
  * };
36
36
  * const command = new DeleteProfileObjectTypeCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DeleteProfileObjectTypeResponse
39
+ * // Message: "STRING_VALUE", // required
40
+ * // };
41
+ *
38
42
  * ```
39
43
  *
40
44
  * @param DeleteProfileObjectTypeCommandInput - {@link DeleteProfileObjectTypeCommandInput}
@@ -58,6 +62,8 @@ export interface DeleteProfileObjectTypeCommandOutput extends DeleteProfileObjec
58
62
  * @throws {@link ThrottlingException} (client fault)
59
63
  * <p>You exceeded the maximum number of requests.</p>
60
64
  *
65
+ * @throws {@link CustomerProfilesServiceException}
66
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
61
67
  *
62
68
  */
63
69
  export declare class DeleteProfileObjectTypeCommand extends $Command<DeleteProfileObjectTypeCommandInput, DeleteProfileObjectTypeCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteWorkflowCommandOutput extends DeleteWorkflowResponse, __M
32
32
  * };
33
33
  * const command = new DeleteWorkflowCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteWorkflowCommandInput - {@link DeleteWorkflowCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteWorkflowCommandOutput extends DeleteWorkflowResponse, __M
55
57
  * @throws {@link ThrottlingException} (client fault)
56
58
  * <p>You exceeded the maximum number of requests.</p>
57
59
  *
60
+ * @throws {@link CustomerProfilesServiceException}
61
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteWorkflowCommand extends $Command<DeleteWorkflowCommandInput, DeleteWorkflowCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -55,6 +55,13 @@ export interface GetAutoMergingPreviewCommandOutput extends GetAutoMergingPrevie
55
55
  * };
56
56
  * const command = new GetAutoMergingPreviewCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // GetAutoMergingPreviewResponse
59
+ * // DomainName: "STRING_VALUE", // required
60
+ * // NumberOfMatchesInSample: Number("long"),
61
+ * // NumberOfProfilesInSample: Number("long"),
62
+ * // NumberOfProfilesWillBeMerged: Number("long"),
63
+ * // };
64
+ *
58
65
  * ```
59
66
  *
60
67
  * @param GetAutoMergingPreviewCommandInput - {@link GetAutoMergingPreviewCommandInput}
@@ -78,6 +85,8 @@ export interface GetAutoMergingPreviewCommandOutput extends GetAutoMergingPrevie
78
85
  * @throws {@link ThrottlingException} (client fault)
79
86
  * <p>You exceeded the maximum number of requests.</p>
80
87
  *
88
+ * @throws {@link CustomerProfilesServiceException}
89
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
81
90
  *
82
91
  */
83
92
  export declare class GetAutoMergingPreviewCommand extends $Command<GetAutoMergingPreviewCommandInput, GetAutoMergingPreviewCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -31,6 +31,52 @@ export interface GetDomainCommandOutput extends GetDomainResponse, __MetadataBea
31
31
  * };
32
32
  * const command = new GetDomainCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetDomainResponse
35
+ * // DomainName: "STRING_VALUE", // required
36
+ * // DefaultExpirationDays: Number("int"),
37
+ * // DefaultEncryptionKey: "STRING_VALUE",
38
+ * // DeadLetterQueueUrl: "STRING_VALUE",
39
+ * // Stats: { // DomainStats
40
+ * // ProfileCount: Number("long"),
41
+ * // MeteringProfileCount: Number("long"),
42
+ * // ObjectCount: Number("long"),
43
+ * // TotalSize: Number("long"),
44
+ * // },
45
+ * // Matching: { // MatchingResponse
46
+ * // Enabled: true || false,
47
+ * // JobSchedule: { // JobSchedule
48
+ * // DayOfTheWeek: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", // required
49
+ * // Time: "STRING_VALUE", // required
50
+ * // },
51
+ * // AutoMerging: { // AutoMerging
52
+ * // Enabled: true || false, // required
53
+ * // Consolidation: { // Consolidation
54
+ * // MatchingAttributesList: [ // MatchingAttributesList // required
55
+ * // [ // MatchingAttributes
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // ],
59
+ * // },
60
+ * // ConflictResolution: { // ConflictResolution
61
+ * // ConflictResolvingModel: "RECENCY" || "SOURCE", // required
62
+ * // SourceName: "STRING_VALUE",
63
+ * // },
64
+ * // MinAllowedConfidenceScoreForMerging: Number("double"),
65
+ * // },
66
+ * // ExportingConfig: { // ExportingConfig
67
+ * // S3Exporting: { // S3ExportingConfig
68
+ * // S3BucketName: "STRING_VALUE", // required
69
+ * // S3KeyName: "STRING_VALUE",
70
+ * // },
71
+ * // },
72
+ * // },
73
+ * // CreatedAt: new Date("TIMESTAMP"), // required
74
+ * // LastUpdatedAt: new Date("TIMESTAMP"), // required
75
+ * // Tags: { // TagMap
76
+ * // "<keys>": "STRING_VALUE",
77
+ * // },
78
+ * // };
79
+ *
34
80
  * ```
35
81
  *
36
82
  * @param GetDomainCommandInput - {@link GetDomainCommandInput}
@@ -54,6 +100,8 @@ export interface GetDomainCommandOutput extends GetDomainResponse, __MetadataBea
54
100
  * @throws {@link ThrottlingException} (client fault)
55
101
  * <p>You exceeded the maximum number of requests.</p>
56
102
  *
103
+ * @throws {@link CustomerProfilesServiceException}
104
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
57
105
  *
58
106
  */
59
107
  export declare class GetDomainCommand extends $Command<GetDomainCommandInput, GetDomainCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -34,6 +34,43 @@ export interface GetIdentityResolutionJobCommandOutput extends GetIdentityResolu
34
34
  * };
35
35
  * const command = new GetIdentityResolutionJobCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // GetIdentityResolutionJobResponse
38
+ * // DomainName: "STRING_VALUE",
39
+ * // JobId: "STRING_VALUE",
40
+ * // Status: "PENDING" || "PREPROCESSING" || "FIND_MATCHING" || "MERGING" || "COMPLETED" || "PARTIAL_SUCCESS" || "FAILED",
41
+ * // Message: "STRING_VALUE",
42
+ * // JobStartTime: new Date("TIMESTAMP"),
43
+ * // JobEndTime: new Date("TIMESTAMP"),
44
+ * // LastUpdatedAt: new Date("TIMESTAMP"),
45
+ * // JobExpirationTime: new Date("TIMESTAMP"),
46
+ * // AutoMerging: { // AutoMerging
47
+ * // Enabled: true || false, // required
48
+ * // Consolidation: { // Consolidation
49
+ * // MatchingAttributesList: [ // MatchingAttributesList // required
50
+ * // [ // MatchingAttributes
51
+ * // "STRING_VALUE",
52
+ * // ],
53
+ * // ],
54
+ * // },
55
+ * // ConflictResolution: { // ConflictResolution
56
+ * // ConflictResolvingModel: "RECENCY" || "SOURCE", // required
57
+ * // SourceName: "STRING_VALUE",
58
+ * // },
59
+ * // MinAllowedConfidenceScoreForMerging: Number("double"),
60
+ * // },
61
+ * // ExportingLocation: { // ExportingLocation
62
+ * // S3Exporting: { // S3ExportingLocation
63
+ * // S3BucketName: "STRING_VALUE",
64
+ * // S3KeyName: "STRING_VALUE",
65
+ * // },
66
+ * // },
67
+ * // JobStats: { // JobStats
68
+ * // NumberOfProfilesReviewed: Number("long"),
69
+ * // NumberOfMatchesFound: Number("long"),
70
+ * // NumberOfMergesDone: Number("long"),
71
+ * // },
72
+ * // };
73
+ *
37
74
  * ```
38
75
  *
39
76
  * @param GetIdentityResolutionJobCommandInput - {@link GetIdentityResolutionJobCommandInput}
@@ -57,6 +94,8 @@ export interface GetIdentityResolutionJobCommandOutput extends GetIdentityResolu
57
94
  * @throws {@link ThrottlingException} (client fault)
58
95
  * <p>You exceeded the maximum number of requests.</p>
59
96
  *
97
+ * @throws {@link CustomerProfilesServiceException}
98
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
60
99
  *
61
100
  */
62
101
  export declare class GetIdentityResolutionJobCommand extends $Command<GetIdentityResolutionJobCommandInput, GetIdentityResolutionJobCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -32,6 +32,22 @@ export interface GetIntegrationCommandOutput extends GetIntegrationResponse, __M
32
32
  * };
33
33
  * const command = new GetIntegrationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetIntegrationResponse
36
+ * // DomainName: "STRING_VALUE", // required
37
+ * // Uri: "STRING_VALUE", // required
38
+ * // ObjectTypeName: "STRING_VALUE",
39
+ * // CreatedAt: new Date("TIMESTAMP"), // required
40
+ * // LastUpdatedAt: new Date("TIMESTAMP"), // required
41
+ * // Tags: { // TagMap
42
+ * // "<keys>": "STRING_VALUE",
43
+ * // },
44
+ * // ObjectTypeNames: { // ObjectTypeNames
45
+ * // "<keys>": "STRING_VALUE",
46
+ * // },
47
+ * // WorkflowId: "STRING_VALUE",
48
+ * // IsUnstructured: true || false,
49
+ * // };
50
+ *
35
51
  * ```
36
52
  *
37
53
  * @param GetIntegrationCommandInput - {@link GetIntegrationCommandInput}
@@ -55,6 +71,8 @@ export interface GetIntegrationCommandOutput extends GetIntegrationResponse, __M
55
71
  * @throws {@link ThrottlingException} (client fault)
56
72
  * <p>You exceeded the maximum number of requests.</p>
57
73
  *
74
+ * @throws {@link CustomerProfilesServiceException}
75
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
58
76
  *
59
77
  */
60
78
  export declare class GetIntegrationCommand extends $Command<GetIntegrationCommandInput, GetIntegrationCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -77,6 +77,21 @@ export interface GetMatchesCommandOutput extends GetMatchesResponse, __MetadataB
77
77
  * };
78
78
  * const command = new GetMatchesCommand(input);
79
79
  * const response = await client.send(command);
80
+ * // { // GetMatchesResponse
81
+ * // NextToken: "STRING_VALUE",
82
+ * // MatchGenerationDate: new Date("TIMESTAMP"),
83
+ * // PotentialMatches: Number("int"),
84
+ * // Matches: [ // MatchesList
85
+ * // { // MatchItem
86
+ * // MatchId: "STRING_VALUE",
87
+ * // ProfileIds: [ // ProfileIdList
88
+ * // "STRING_VALUE",
89
+ * // ],
90
+ * // ConfidenceScore: Number("double"),
91
+ * // },
92
+ * // ],
93
+ * // };
94
+ *
80
95
  * ```
81
96
  *
82
97
  * @param GetMatchesCommandInput - {@link GetMatchesCommandInput}
@@ -100,6 +115,8 @@ export interface GetMatchesCommandOutput extends GetMatchesResponse, __MetadataB
100
115
  * @throws {@link ThrottlingException} (client fault)
101
116
  * <p>You exceeded the maximum number of requests.</p>
102
117
  *
118
+ * @throws {@link CustomerProfilesServiceException}
119
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
103
120
  *
104
121
  */
105
122
  export declare class GetMatchesCommand extends $Command<GetMatchesCommandInput, GetMatchesCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -32,6 +32,40 @@ export interface GetProfileObjectTypeCommandOutput extends GetProfileObjectTypeR
32
32
  * };
33
33
  * const command = new GetProfileObjectTypeCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetProfileObjectTypeResponse
36
+ * // ObjectTypeName: "STRING_VALUE", // required
37
+ * // Description: "STRING_VALUE", // required
38
+ * // TemplateId: "STRING_VALUE",
39
+ * // ExpirationDays: Number("int"),
40
+ * // EncryptionKey: "STRING_VALUE",
41
+ * // AllowProfileCreation: true || false,
42
+ * // SourceLastUpdatedTimestampFormat: "STRING_VALUE",
43
+ * // Fields: { // FieldMap
44
+ * // "<keys>": { // ObjectTypeField
45
+ * // Source: "STRING_VALUE",
46
+ * // Target: "STRING_VALUE",
47
+ * // ContentType: "STRING" || "NUMBER" || "PHONE_NUMBER" || "EMAIL_ADDRESS" || "NAME",
48
+ * // },
49
+ * // },
50
+ * // Keys: { // KeyMap
51
+ * // "<keys>": [ // ObjectTypeKeyList
52
+ * // { // ObjectTypeKey
53
+ * // StandardIdentifiers: [ // StandardIdentifierList
54
+ * // "PROFILE" || "ASSET" || "CASE" || "UNIQUE" || "SECONDARY" || "LOOKUP_ONLY" || "NEW_ONLY" || "ORDER",
55
+ * // ],
56
+ * // FieldNames: [ // FieldNameList
57
+ * // "STRING_VALUE",
58
+ * // ],
59
+ * // },
60
+ * // ],
61
+ * // },
62
+ * // CreatedAt: new Date("TIMESTAMP"),
63
+ * // LastUpdatedAt: new Date("TIMESTAMP"),
64
+ * // Tags: { // TagMap
65
+ * // "<keys>": "STRING_VALUE",
66
+ * // },
67
+ * // };
68
+ *
35
69
  * ```
36
70
  *
37
71
  * @param GetProfileObjectTypeCommandInput - {@link GetProfileObjectTypeCommandInput}
@@ -55,6 +89,8 @@ export interface GetProfileObjectTypeCommandOutput extends GetProfileObjectTypeR
55
89
  * @throws {@link ThrottlingException} (client fault)
56
90
  * <p>You exceeded the maximum number of requests.</p>
57
91
  *
92
+ * @throws {@link CustomerProfilesServiceException}
93
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
58
94
  *
59
95
  */
60
96
  export declare class GetProfileObjectTypeCommand extends $Command<GetProfileObjectTypeCommandInput, GetProfileObjectTypeCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -35,6 +35,33 @@ export interface GetProfileObjectTypeTemplateCommandOutput extends GetProfileObj
35
35
  * };
36
36
  * const command = new GetProfileObjectTypeTemplateCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // GetProfileObjectTypeTemplateResponse
39
+ * // TemplateId: "STRING_VALUE",
40
+ * // SourceName: "STRING_VALUE",
41
+ * // SourceObject: "STRING_VALUE",
42
+ * // AllowProfileCreation: true || false,
43
+ * // SourceLastUpdatedTimestampFormat: "STRING_VALUE",
44
+ * // Fields: { // FieldMap
45
+ * // "<keys>": { // ObjectTypeField
46
+ * // Source: "STRING_VALUE",
47
+ * // Target: "STRING_VALUE",
48
+ * // ContentType: "STRING" || "NUMBER" || "PHONE_NUMBER" || "EMAIL_ADDRESS" || "NAME",
49
+ * // },
50
+ * // },
51
+ * // Keys: { // KeyMap
52
+ * // "<keys>": [ // ObjectTypeKeyList
53
+ * // { // ObjectTypeKey
54
+ * // StandardIdentifiers: [ // StandardIdentifierList
55
+ * // "PROFILE" || "ASSET" || "CASE" || "UNIQUE" || "SECONDARY" || "LOOKUP_ONLY" || "NEW_ONLY" || "ORDER",
56
+ * // ],
57
+ * // FieldNames: [ // FieldNameList
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // },
61
+ * // ],
62
+ * // },
63
+ * // };
64
+ *
38
65
  * ```
39
66
  *
40
67
  * @param GetProfileObjectTypeTemplateCommandInput - {@link GetProfileObjectTypeTemplateCommandInput}
@@ -58,6 +85,8 @@ export interface GetProfileObjectTypeTemplateCommandOutput extends GetProfileObj
58
85
  * @throws {@link ThrottlingException} (client fault)
59
86
  * <p>You exceeded the maximum number of requests.</p>
60
87
  *
88
+ * @throws {@link CustomerProfilesServiceException}
89
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
61
90
  *
62
91
  */
63
92
  export declare class GetProfileObjectTypeTemplateCommand extends $Command<GetProfileObjectTypeTemplateCommandInput, GetProfileObjectTypeTemplateCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -32,6 +32,29 @@ export interface GetWorkflowCommandOutput extends GetWorkflowResponse, __Metadat
32
32
  * };
33
33
  * const command = new GetWorkflowCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetWorkflowResponse
36
+ * // WorkflowId: "STRING_VALUE",
37
+ * // WorkflowType: "APPFLOW_INTEGRATION",
38
+ * // Status: "NOT_STARTED" || "IN_PROGRESS" || "COMPLETE" || "FAILED" || "SPLIT" || "RETRY" || "CANCELLED",
39
+ * // ErrorDescription: "STRING_VALUE",
40
+ * // StartDate: new Date("TIMESTAMP"),
41
+ * // LastUpdatedAt: new Date("TIMESTAMP"),
42
+ * // Attributes: { // WorkflowAttributes
43
+ * // AppflowIntegration: { // AppflowIntegrationWorkflowAttributes
44
+ * // SourceConnectorType: "Salesforce" || "Marketo" || "Zendesk" || "Servicenow" || "S3", // required
45
+ * // ConnectorProfileName: "STRING_VALUE", // required
46
+ * // RoleArn: "STRING_VALUE",
47
+ * // },
48
+ * // },
49
+ * // Metrics: { // WorkflowMetrics
50
+ * // AppflowIntegration: { // AppflowIntegrationWorkflowMetrics
51
+ * // RecordsProcessed: Number("long"), // required
52
+ * // StepsCompleted: Number("long"), // required
53
+ * // TotalSteps: Number("long"), // required
54
+ * // },
55
+ * // },
56
+ * // };
57
+ *
35
58
  * ```
36
59
  *
37
60
  * @param GetWorkflowCommandInput - {@link GetWorkflowCommandInput}
@@ -55,6 +78,8 @@ export interface GetWorkflowCommandOutput extends GetWorkflowResponse, __Metadat
55
78
  * @throws {@link ThrottlingException} (client fault)
56
79
  * <p>You exceeded the maximum number of requests.</p>
57
80
  *
81
+ * @throws {@link CustomerProfilesServiceException}
82
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
58
83
  *
59
84
  */
60
85
  export declare class GetWorkflowCommand extends $Command<GetWorkflowCommandInput, GetWorkflowCommandOutput, CustomerProfilesClientResolvedConfig> {
@@ -34,6 +34,26 @@ export interface GetWorkflowStepsCommandOutput extends GetWorkflowStepsResponse,
34
34
  * };
35
35
  * const command = new GetWorkflowStepsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // GetWorkflowStepsResponse
38
+ * // WorkflowId: "STRING_VALUE",
39
+ * // WorkflowType: "APPFLOW_INTEGRATION",
40
+ * // Items: [ // WorkflowStepsList
41
+ * // { // WorkflowStepItem
42
+ * // AppflowIntegration: { // AppflowIntegrationWorkflowStep
43
+ * // FlowName: "STRING_VALUE", // required
44
+ * // Status: "NOT_STARTED" || "IN_PROGRESS" || "COMPLETE" || "FAILED" || "SPLIT" || "RETRY" || "CANCELLED", // required
45
+ * // ExecutionMessage: "STRING_VALUE", // required
46
+ * // RecordsProcessed: Number("long"), // required
47
+ * // BatchRecordsStartTime: "STRING_VALUE", // required
48
+ * // BatchRecordsEndTime: "STRING_VALUE", // required
49
+ * // CreatedAt: new Date("TIMESTAMP"), // required
50
+ * // LastUpdatedAt: new Date("TIMESTAMP"), // required
51
+ * // },
52
+ * // },
53
+ * // ],
54
+ * // NextToken: "STRING_VALUE",
55
+ * // };
56
+ *
37
57
  * ```
38
58
  *
39
59
  * @param GetWorkflowStepsCommandInput - {@link GetWorkflowStepsCommandInput}
@@ -57,6 +77,8 @@ export interface GetWorkflowStepsCommandOutput extends GetWorkflowStepsResponse,
57
77
  * @throws {@link ThrottlingException} (client fault)
58
78
  * <p>You exceeded the maximum number of requests.</p>
59
79
  *
80
+ * @throws {@link CustomerProfilesServiceException}
81
+ * <p>Base exception class for all service exceptions from CustomerProfiles service.</p>
60
82
  *
61
83
  */
62
84
  export declare class GetWorkflowStepsCommand extends $Command<GetWorkflowStepsCommandInput, GetWorkflowStepsCommandOutput, CustomerProfilesClientResolvedConfig> {