@aws-sdk/client-entityresolution 3.378.0

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

@@ -0,0 +1,95 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { EntityResolutionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EntityResolutionClient";
+import { TagResourceInput, TagResourceOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandInput extends TagResourceInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution
+ *          resource. Tags can help you organize and categorize your resources. You can also use them
+ *          to scope user permissions by granting a user permission to access or change only resources
+ *          with certain tag values. In Entity Resolution, <code>SchemaMapping</code>, and
+ *             <code>MatchingWorkflow</code> can be tagged. Tags don't have any semantic meaning to AWS
+ *          and are interpreted strictly as strings of characters. You can use the
+ *             <code>TagResource</code> action with a resource that already has tags. If you specify a
+ *          new tag key, this tag is appended to the list of tags associated with the resource. If you
+ *          specify a tag key that is already associated with the resource, the new tag value that you
+ *          specify replaces the previous value for that tag.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EntityResolutionClient, TagResourceCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
+ * // const { EntityResolutionClient, TagResourceCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
+ * const client = new EntityResolutionClient(config);
+ * const input = { // TagResourceInput
+ *   resourceArn: "STRING_VALUE", // required
+ *   tags: { // TagMap // required
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
+ * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
+ *          </p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource could not be found. <code>HTTP Status Code: 404</code>
+ *          </p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
+ *          </p>
+ *
+ * @throws {@link EntityResolutionServiceException}
+ * <p>Base exception class for all service exceptions from EntityResolution service.</p>
+ *
+ */
+export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, EntityResolutionClientResolvedConfig> {
+    readonly input: TagResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: TagResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EntityResolutionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,84 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { EntityResolutionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EntityResolutionClient";
+import { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandInput extends UntagResourceInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Removes one or more tags from the specified AWS Entity Resolution resource. In Entity
+ *          Resolution, <code>SchemaMapping</code>, and <code>MatchingWorkflow</code> can be
+ *          tagged.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EntityResolutionClient, UntagResourceCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
+ * // const { EntityResolutionClient, UntagResourceCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
+ * const client = new EntityResolutionClient(config);
+ * const input = { // UntagResourceInput
+ *   resourceArn: "STRING_VALUE", // required
+ *   tagKeys: [ // TagKeyList // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
+ * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
+ *          </p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource could not be found. <code>HTTP Status Code: 404</code>
+ *          </p>
+ *
+ * @throws {@link EntityResolutionServiceException}
+ * <p>Base exception class for all service exceptions from EntityResolution service.</p>
+ *
+ */
+export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, EntityResolutionClientResolvedConfig> {
+    readonly input: UntagResourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UntagResourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EntityResolutionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,174 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { EntityResolutionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EntityResolutionClient";
+import { UpdateMatchingWorkflowInput, UpdateMatchingWorkflowOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateMatchingWorkflowCommand}.
+ */
+export interface UpdateMatchingWorkflowCommandInput extends UpdateMatchingWorkflowInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateMatchingWorkflowCommand}.
+ */
+export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkflowOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates an existing <code>MatchingWorkflow</code>. This method is identical to
+ *          <code>CreateMatchingWorkflow</code>, except it uses an HTTP <code>PUT</code> request instead of
+ *          a <code>POST</code> request, and the <code>MatchingWorkflow</code> must already exist for the
+ *          method to succeed.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EntityResolutionClient, UpdateMatchingWorkflowCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
+ * // const { EntityResolutionClient, UpdateMatchingWorkflowCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
+ * const client = new EntityResolutionClient(config);
+ * const input = { // UpdateMatchingWorkflowInput
+ *   workflowName: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   inputSourceConfig: [ // InputSourceConfig // required
+ *     { // InputSource
+ *       inputSourceARN: "STRING_VALUE", // required
+ *       schemaName: "STRING_VALUE", // required
+ *       applyNormalization: true || false,
+ *     },
+ *   ],
+ *   outputSourceConfig: [ // OutputSourceConfig // required
+ *     { // OutputSource
+ *       outputS3Path: "STRING_VALUE", // required
+ *       output: [ // OutputAttributes // required
+ *         { // OutputAttribute
+ *           name: "STRING_VALUE", // required
+ *           hashed: true || false,
+ *         },
+ *       ],
+ *       KMSArn: "STRING_VALUE",
+ *       applyNormalization: true || false,
+ *     },
+ *   ],
+ *   resolutionTechniques: { // ResolutionTechniques
+ *     resolutionType: "RULE_MATCHING" || "ML_MATCHING",
+ *     ruleBasedProperties: { // RuleBasedProperties
+ *       rules: [ // RuleList // required
+ *         { // Rule
+ *           ruleName: "STRING_VALUE", // required
+ *           matchingKeys: [ // MatchingKeys // required
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *       ],
+ *       attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
+ *     },
+ *   },
+ *   incrementalRunConfig: { // IncrementalRunConfig
+ *     incrementalRunType: "IMMEDIATE",
+ *   },
+ *   roleArn: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateMatchingWorkflowCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateMatchingWorkflowOutput
+ * //   workflowName: "STRING_VALUE", // required
+ * //   description: "STRING_VALUE",
+ * //   inputSourceConfig: [ // InputSourceConfig // required
+ * //     { // InputSource
+ * //       inputSourceARN: "STRING_VALUE", // required
+ * //       schemaName: "STRING_VALUE", // required
+ * //       applyNormalization: true || false,
+ * //     },
+ * //   ],
+ * //   outputSourceConfig: [ // OutputSourceConfig // required
+ * //     { // OutputSource
+ * //       outputS3Path: "STRING_VALUE", // required
+ * //       output: [ // OutputAttributes // required
+ * //         { // OutputAttribute
+ * //           name: "STRING_VALUE", // required
+ * //           hashed: true || false,
+ * //         },
+ * //       ],
+ * //       KMSArn: "STRING_VALUE",
+ * //       applyNormalization: true || false,
+ * //     },
+ * //   ],
+ * //   resolutionTechniques: { // ResolutionTechniques
+ * //     resolutionType: "RULE_MATCHING" || "ML_MATCHING",
+ * //     ruleBasedProperties: { // RuleBasedProperties
+ * //       rules: [ // RuleList // required
+ * //         { // Rule
+ * //           ruleName: "STRING_VALUE", // required
+ * //           matchingKeys: [ // MatchingKeys // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //       ],
+ * //       attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
+ * //     },
+ * //   },
+ * //   incrementalRunConfig: { // IncrementalRunConfig
+ * //     incrementalRunType: "IMMEDIATE",
+ * //   },
+ * //   roleArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateMatchingWorkflowCommandInput - {@link UpdateMatchingWorkflowCommandInput}
+ * @returns {@link UpdateMatchingWorkflowCommandOutput}
+ * @see {@link UpdateMatchingWorkflowCommandInput} for command's `input` shape.
+ * @see {@link UpdateMatchingWorkflowCommandOutput} for command's `response` shape.
+ * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action. <code>HTTP Status Code: 403</code>
+ *          </p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
+ *          </p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource could not be found. <code>HTTP Status Code: 404</code>
+ *          </p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
+ *          </p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
+ *          </p>
+ *
+ * @throws {@link EntityResolutionServiceException}
+ * <p>Base exception class for all service exceptions from EntityResolution service.</p>
+ *
+ */
+export declare class UpdateMatchingWorkflowCommand extends $Command<UpdateMatchingWorkflowCommandInput, UpdateMatchingWorkflowCommandOutput, EntityResolutionClientResolvedConfig> {
+    readonly input: UpdateMatchingWorkflowCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateMatchingWorkflowCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EntityResolutionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateMatchingWorkflowCommandInput, UpdateMatchingWorkflowCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,16 @@
+export * from "./CreateMatchingWorkflowCommand";
+export * from "./CreateSchemaMappingCommand";
+export * from "./DeleteMatchingWorkflowCommand";
+export * from "./DeleteSchemaMappingCommand";
+export * from "./GetMatchIdCommand";
+export * from "./GetMatchingJobCommand";
+export * from "./GetMatchingWorkflowCommand";
+export * from "./GetSchemaMappingCommand";
+export * from "./ListMatchingJobsCommand";
+export * from "./ListMatchingWorkflowsCommand";
+export * from "./ListSchemaMappingsCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./StartMatchingJobCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateMatchingWorkflowCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,19 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    useDualstackEndpoint?: boolean | Provider<boolean>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string;
+    UseDualStack?: boolean;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * <p>Welcome to the <i>AWS Entity Resolution API Reference</i>.</p>
+ *          <p>AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities
+ *          that enable developers and analysts at advertising and marketing companies to build an accurate and
+ *         complete view of their consumers.</p>
+ *          <p>
+ *          With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers,
+ *          such as name, email address, and phone number. This holds true even when these records have incomplete or
+ *          conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a
+ *          customer relationship management (CRM) system, which includes account information like first name, last name,
+ *          postal address, phone number, and email address, with a source record from a marketing system containing
+ *          campaign information, such as username and email address.</p>
+ *          <p>To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the
+ *          <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">AWS Entity Resolution
+ *             User Guide</a>.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./EntityResolutionClient";
+export * from "./EntityResolution";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models";
+export { EntityResolutionServiceException } from "./models/EntityResolutionServiceException";

package/dist-types/models/EntityResolutionServiceException.d.ts

@@ -0,0 +1,13 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export { __ServiceException, __ServiceExceptionOptions };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from EntityResolution service.
+ */
+export declare class EntityResolutionServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./models_0";