@aws-sdk/client-customer-profiles 3.295.0 → 3.297.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 (43) hide show
  1. package/dist-types/CustomerProfiles.d.ts +39 -0
  2. package/dist-types/CustomerProfilesClient.d.ts +24 -4
  3. package/dist-types/commands/AddProfileKeyCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateDomainCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateIntegrationWorkflowCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateProfileCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteDomainCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteIntegrationCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteProfileCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteProfileKeyCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteProfileObjectCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteProfileObjectTypeCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteWorkflowCommand.d.ts +16 -0
  14. package/dist-types/commands/GetAutoMergingPreviewCommand.d.ts +16 -0
  15. package/dist-types/commands/GetDomainCommand.d.ts +16 -0
  16. package/dist-types/commands/GetIdentityResolutionJobCommand.d.ts +16 -0
  17. package/dist-types/commands/GetIntegrationCommand.d.ts +16 -0
  18. package/dist-types/commands/GetMatchesCommand.d.ts +16 -0
  19. package/dist-types/commands/GetProfileObjectTypeCommand.d.ts +16 -0
  20. package/dist-types/commands/GetProfileObjectTypeTemplateCommand.d.ts +16 -0
  21. package/dist-types/commands/GetWorkflowCommand.d.ts +16 -0
  22. package/dist-types/commands/GetWorkflowStepsCommand.d.ts +16 -0
  23. package/dist-types/commands/ListAccountIntegrationsCommand.d.ts +16 -0
  24. package/dist-types/commands/ListDomainsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListIdentityResolutionJobsCommand.d.ts +16 -0
  26. package/dist-types/commands/ListIntegrationsCommand.d.ts +16 -0
  27. package/dist-types/commands/ListProfileObjectTypeTemplatesCommand.d.ts +16 -0
  28. package/dist-types/commands/ListProfileObjectTypesCommand.d.ts +16 -0
  29. package/dist-types/commands/ListProfileObjectsCommand.d.ts +16 -0
  30. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  31. package/dist-types/commands/ListWorkflowsCommand.d.ts +16 -0
  32. package/dist-types/commands/MergeProfilesCommand.d.ts +16 -0
  33. package/dist-types/commands/PutIntegrationCommand.d.ts +16 -0
  34. package/dist-types/commands/PutProfileObjectCommand.d.ts +16 -0
  35. package/dist-types/commands/PutProfileObjectTypeCommand.d.ts +16 -0
  36. package/dist-types/commands/SearchProfilesCommand.d.ts +16 -0
  37. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  38. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  39. package/dist-types/commands/UpdateDomainCommand.d.ts +16 -0
  40. package/dist-types/commands/UpdateProfileCommand.d.ts +16 -0
  41. package/dist-types/models/CustomerProfilesServiceException.d.ts +2 -0
  42. package/dist-types/models/models_0.d.ts +345 -0
  43. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { DeleteIntegrationRequest, DeleteIntegrationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteIntegrationCommand}.
8
10
  */
9
11
  export interface DeleteIntegrationCommandInput extends DeleteIntegrationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteIntegrationCommand}.
13
17
  */
14
18
  export interface DeleteIntegrationCommandOutput extends DeleteIntegrationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes an integration from a specific domain.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteIntegrationCommandOutput extends DeleteIntegrationRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteIntegrationCommandInput - {@link DeleteIntegrationCommandInput}
34
+ * @returns {@link DeleteIntegrationCommandOutput}
28
35
  * @see {@link DeleteIntegrationCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteIntegrationCommandOutput} for command's `response` shape.
30
37
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteIntegrationCommandOutput extends DeleteIntegrationRespons
49
56
  export declare class DeleteIntegrationCommand extends $Command<DeleteIntegrationCommandInput, DeleteIntegrationCommandOutput, CustomerProfilesClientResolvedConfig> {
50
57
  readonly input: DeleteIntegrationCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteIntegrationCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteIntegrationCommandInput, DeleteIntegrationCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { DeleteProfileRequest, DeleteProfileResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteProfileCommand}.
8
10
  */
9
11
  export interface DeleteProfileCommandInput extends DeleteProfileRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteProfileCommand}.
13
17
  */
14
18
  export interface DeleteProfileCommandOutput extends DeleteProfileResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the standard customer profile and all data pertaining to the profile.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteProfileCommandOutput extends DeleteProfileResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteProfileCommandInput - {@link DeleteProfileCommandInput}
34
+ * @returns {@link DeleteProfileCommandOutput}
28
35
  * @see {@link DeleteProfileCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteProfileCommandOutput} for command's `response` shape.
30
37
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteProfileCommandOutput extends DeleteProfileResponse, __Met
49
56
  export declare class DeleteProfileCommand extends $Command<DeleteProfileCommandInput, DeleteProfileCommandOutput, CustomerProfilesClientResolvedConfig> {
50
57
  readonly input: DeleteProfileCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteProfileCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProfileCommandInput, DeleteProfileCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { DeleteProfileKeyRequest, DeleteProfileKeyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteProfileKeyCommand}.
8
10
  */
9
11
  export interface DeleteProfileKeyCommandInput extends DeleteProfileKeyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteProfileKeyCommand}.
13
17
  */
14
18
  export interface DeleteProfileKeyCommandOutput extends DeleteProfileKeyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a searchable key from a customer profile.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteProfileKeyCommandOutput extends DeleteProfileKeyResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteProfileKeyCommandInput - {@link DeleteProfileKeyCommandInput}
34
+ * @returns {@link DeleteProfileKeyCommandOutput}
28
35
  * @see {@link DeleteProfileKeyCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteProfileKeyCommandOutput} for command's `response` shape.
30
37
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteProfileKeyCommandOutput extends DeleteProfileKeyResponse,
49
56
  export declare class DeleteProfileKeyCommand extends $Command<DeleteProfileKeyCommandInput, DeleteProfileKeyCommandOutput, CustomerProfilesClientResolvedConfig> {
50
57
  readonly input: DeleteProfileKeyCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteProfileKeyCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProfileKeyCommandInput, DeleteProfileKeyCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { DeleteProfileObjectRequest, DeleteProfileObjectResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteProfileObjectCommand}.
8
10
  */
9
11
  export interface DeleteProfileObjectCommandInput extends DeleteProfileObjectRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteProfileObjectCommand}.
13
17
  */
14
18
  export interface DeleteProfileObjectCommandOutput extends DeleteProfileObjectResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes an object associated with a profile of a given ProfileObjectType.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteProfileObjectCommandOutput extends DeleteProfileObjectRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteProfileObjectCommandInput - {@link DeleteProfileObjectCommandInput}
34
+ * @returns {@link DeleteProfileObjectCommandOutput}
28
35
  * @see {@link DeleteProfileObjectCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteProfileObjectCommandOutput} for command's `response` shape.
30
37
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteProfileObjectCommandOutput extends DeleteProfileObjectRes
49
56
  export declare class DeleteProfileObjectCommand extends $Command<DeleteProfileObjectCommandInput, DeleteProfileObjectCommandOutput, CustomerProfilesClientResolvedConfig> {
50
57
  readonly input: DeleteProfileObjectCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteProfileObjectCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProfileObjectCommandInput, DeleteProfileObjectCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { DeleteProfileObjectTypeRequest, DeleteProfileObjectTypeResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteProfileObjectTypeCommand}.
8
10
  */
9
11
  export interface DeleteProfileObjectTypeCommandInput extends DeleteProfileObjectTypeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteProfileObjectTypeCommand}.
13
17
  */
14
18
  export interface DeleteProfileObjectTypeCommandOutput extends DeleteProfileObjectTypeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a ProfileObjectType from a specific domain as well as removes all the
18
23
  * ProfileObjects of that type. It also disables integrations from this specific
19
24
  * ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that
@@ -28,6 +33,8 @@ export interface DeleteProfileObjectTypeCommandOutput extends DeleteProfileObjec
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteProfileObjectTypeCommandInput - {@link DeleteProfileObjectTypeCommandInput}
37
+ * @returns {@link DeleteProfileObjectTypeCommandOutput}
31
38
  * @see {@link DeleteProfileObjectTypeCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteProfileObjectTypeCommandOutput} for command's `response` shape.
33
40
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteProfileObjectTypeCommandOutput extends DeleteProfileObjec
52
59
  export declare class DeleteProfileObjectTypeCommand extends $Command<DeleteProfileObjectTypeCommandInput, DeleteProfileObjectTypeCommandOutput, CustomerProfilesClientResolvedConfig> {
53
60
  readonly input: DeleteProfileObjectTypeCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteProfileObjectTypeCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProfileObjectTypeCommandInput, DeleteProfileObjectTypeCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { DeleteWorkflowRequest, DeleteWorkflowResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteWorkflowCommand}.
8
10
  */
9
11
  export interface DeleteWorkflowCommandInput extends DeleteWorkflowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteWorkflowCommand}.
13
17
  */
14
18
  export interface DeleteWorkflowCommandOutput extends DeleteWorkflowResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified workflow and all its corresponding resources. This is an async process.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteWorkflowCommandOutput extends DeleteWorkflowResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteWorkflowCommandInput - {@link DeleteWorkflowCommandInput}
34
+ * @returns {@link DeleteWorkflowCommandOutput}
28
35
  * @see {@link DeleteWorkflowCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteWorkflowCommandOutput} for command's `response` shape.
30
37
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteWorkflowCommandOutput extends DeleteWorkflowResponse, __M
49
56
  export declare class DeleteWorkflowCommand extends $Command<DeleteWorkflowCommandInput, DeleteWorkflowCommandOutput, CustomerProfilesClientResolvedConfig> {
50
57
  readonly input: DeleteWorkflowCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteWorkflowCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWorkflowCommandInput, DeleteWorkflowCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { GetAutoMergingPreviewRequest, GetAutoMergingPreviewResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetAutoMergingPreviewCommand}.
8
10
  */
9
11
  export interface GetAutoMergingPreviewCommandInput extends GetAutoMergingPreviewRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetAutoMergingPreviewCommand}.
13
17
  */
14
18
  export interface GetAutoMergingPreviewCommandOutput extends GetAutoMergingPreviewResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly
18
23
  * selects a sample of matching groups from the existing matching results, and applies the
19
24
  * automerging settings that you provided. You can then view the number of profiles in the
@@ -37,6 +42,8 @@ export interface GetAutoMergingPreviewCommandOutput extends GetAutoMergingPrevie
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param GetAutoMergingPreviewCommandInput - {@link GetAutoMergingPreviewCommandInput}
46
+ * @returns {@link GetAutoMergingPreviewCommandOutput}
40
47
  * @see {@link GetAutoMergingPreviewCommandInput} for command's `input` shape.
41
48
  * @see {@link GetAutoMergingPreviewCommandOutput} for command's `response` shape.
42
49
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -61,11 +68,20 @@ export interface GetAutoMergingPreviewCommandOutput extends GetAutoMergingPrevie
61
68
  export declare class GetAutoMergingPreviewCommand extends $Command<GetAutoMergingPreviewCommandInput, GetAutoMergingPreviewCommandOutput, CustomerProfilesClientResolvedConfig> {
62
69
  readonly input: GetAutoMergingPreviewCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: GetAutoMergingPreviewCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAutoMergingPreviewCommandInput, GetAutoMergingPreviewCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { GetDomainRequest, GetDomainResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDomainCommand}.
8
10
  */
9
11
  export interface GetDomainCommandInput extends GetDomainRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDomainCommand}.
13
17
  */
14
18
  export interface GetDomainCommandOutput extends GetDomainResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about a specific domain.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetDomainCommandOutput extends GetDomainResponse, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetDomainCommandInput - {@link GetDomainCommandInput}
34
+ * @returns {@link GetDomainCommandOutput}
28
35
  * @see {@link GetDomainCommandInput} for command's `input` shape.
29
36
  * @see {@link GetDomainCommandOutput} for command's `response` shape.
30
37
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetDomainCommandOutput extends GetDomainResponse, __MetadataBea
49
56
  export declare class GetDomainCommand extends $Command<GetDomainCommandInput, GetDomainCommandOutput, CustomerProfilesClientResolvedConfig> {
50
57
  readonly input: GetDomainCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetDomainCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDomainCommandInput, GetDomainCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { GetIdentityResolutionJobRequest, GetIdentityResolutionJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetIdentityResolutionJobCommand}.
8
10
  */
9
11
  export interface GetIdentityResolutionJobCommandInput extends GetIdentityResolutionJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetIdentityResolutionJobCommand}.
13
17
  */
14
18
  export interface GetIdentityResolutionJobCommandOutput extends GetIdentityResolutionJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about an Identity Resolution Job in a specific domain. </p>
18
23
  * <p>Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html">Use
19
24
  * Identity Resolution to consolidate similar profiles</a>.</p>
@@ -27,6 +32,8 @@ export interface GetIdentityResolutionJobCommandOutput extends GetIdentityResolu
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetIdentityResolutionJobCommandInput - {@link GetIdentityResolutionJobCommandInput}
36
+ * @returns {@link GetIdentityResolutionJobCommandOutput}
30
37
  * @see {@link GetIdentityResolutionJobCommandInput} for command's `input` shape.
31
38
  * @see {@link GetIdentityResolutionJobCommandOutput} for command's `response` shape.
32
39
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -51,11 +58,20 @@ export interface GetIdentityResolutionJobCommandOutput extends GetIdentityResolu
51
58
  export declare class GetIdentityResolutionJobCommand extends $Command<GetIdentityResolutionJobCommandInput, GetIdentityResolutionJobCommandOutput, CustomerProfilesClientResolvedConfig> {
52
59
  readonly input: GetIdentityResolutionJobCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: GetIdentityResolutionJobCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetIdentityResolutionJobCommandInput, GetIdentityResolutionJobCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { GetIntegrationRequest, GetIntegrationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetIntegrationCommand}.
8
10
  */
9
11
  export interface GetIntegrationCommandInput extends GetIntegrationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetIntegrationCommand}.
13
17
  */
14
18
  export interface GetIntegrationCommandOutput extends GetIntegrationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns an integration for a domain.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetIntegrationCommandOutput extends GetIntegrationResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetIntegrationCommandInput - {@link GetIntegrationCommandInput}
34
+ * @returns {@link GetIntegrationCommandOutput}
28
35
  * @see {@link GetIntegrationCommandInput} for command's `input` shape.
29
36
  * @see {@link GetIntegrationCommandOutput} for command's `response` shape.
30
37
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetIntegrationCommandOutput extends GetIntegrationResponse, __M
49
56
  export declare class GetIntegrationCommand extends $Command<GetIntegrationCommandInput, GetIntegrationCommandOutput, CustomerProfilesClientResolvedConfig> {
50
57
  readonly input: GetIntegrationCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetIntegrationCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetIntegrationCommandInput, GetIntegrationCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { GetMatchesRequest, GetMatchesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetMatchesCommand}.
8
10
  */
9
11
  export interface GetMatchesCommandInput extends GetMatchesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetMatchesCommand}.
13
17
  */
14
18
  export interface GetMatchesCommandOutput extends GetMatchesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Before calling this API, use <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or
18
23
  * <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to
19
24
  * enable identity resolution: set <code>Matching</code> to true.</p>
@@ -69,6 +74,8 @@ export interface GetMatchesCommandOutput extends GetMatchesResponse, __MetadataB
69
74
  * const response = await client.send(command);
70
75
  * ```
71
76
  *
77
+ * @param GetMatchesCommandInput - {@link GetMatchesCommandInput}
78
+ * @returns {@link GetMatchesCommandOutput}
72
79
  * @see {@link GetMatchesCommandInput} for command's `input` shape.
73
80
  * @see {@link GetMatchesCommandOutput} for command's `response` shape.
74
81
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -93,11 +100,20 @@ export interface GetMatchesCommandOutput extends GetMatchesResponse, __MetadataB
93
100
  export declare class GetMatchesCommand extends $Command<GetMatchesCommandInput, GetMatchesCommandOutput, CustomerProfilesClientResolvedConfig> {
94
101
  readonly input: GetMatchesCommandInput;
95
102
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
103
+ /**
104
+ * @public
105
+ */
96
106
  constructor(input: GetMatchesCommandInput);
97
107
  /**
98
108
  * @internal
99
109
  */
100
110
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMatchesCommandInput, GetMatchesCommandOutput>;
111
+ /**
112
+ * @internal
113
+ */
101
114
  private serialize;
115
+ /**
116
+ * @internal
117
+ */
102
118
  private deserialize;
103
119
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CustomerProfilesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CustomerProfilesClient";
5
5
  import { GetProfileObjectTypeRequest, GetProfileObjectTypeResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetProfileObjectTypeCommand}.
8
10
  */
9
11
  export interface GetProfileObjectTypeCommandInput extends GetProfileObjectTypeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetProfileObjectTypeCommand}.
13
17
  */
14
18
  export interface GetProfileObjectTypeCommandOutput extends GetProfileObjectTypeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the object types for a specific domain.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetProfileObjectTypeCommandOutput extends GetProfileObjectTypeR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetProfileObjectTypeCommandInput - {@link GetProfileObjectTypeCommandInput}
34
+ * @returns {@link GetProfileObjectTypeCommandOutput}
28
35
  * @see {@link GetProfileObjectTypeCommandInput} for command's `input` shape.
29
36
  * @see {@link GetProfileObjectTypeCommandOutput} for command's `response` shape.
30
37
  * @see {@link CustomerProfilesClientResolvedConfig | config} for CustomerProfilesClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetProfileObjectTypeCommandOutput extends GetProfileObjectTypeR
49
56
  export declare class GetProfileObjectTypeCommand extends $Command<GetProfileObjectTypeCommandInput, GetProfileObjectTypeCommandOutput, CustomerProfilesClientResolvedConfig> {
50
57
  readonly input: GetProfileObjectTypeCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetProfileObjectTypeCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CustomerProfilesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetProfileObjectTypeCommandInput, GetProfileObjectTypeCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }