Welcome to the AWS Entity Resolution API Reference.
+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.
++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.
+To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the +AWS Entity Resolution +User Guide.
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-entityresolution +using your favorite package manager: + +- `npm install @aws-sdk/client-entityresolution` +- `yarn add @aws-sdk/client-entityresolution` +- `pnpm add @aws-sdk/client-entityresolution` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `EntityResolutionClient` and +the commands you need, for example `CreateMatchingWorkflowCommand`: + +```js +// ES5 example +const { EntityResolutionClient, CreateMatchingWorkflowCommand } = require("@aws-sdk/client-entityresolution"); +``` + +```ts +// ES6+ example +import { EntityResolutionClient, CreateMatchingWorkflowCommand } from "@aws-sdk/client-entityresolution"; +``` + +### Usage + +To send a request, you: + +- Initiate client with configuration (e.g. credentials, region). +- Initiate command with input parameters. +- Call `send` operation on client with command object as input. +- If you are using a custom http handler, you may call `destroy()` to close open connections. + +```js +// a client can be shared by different commands. +const client = new EntityResolutionClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new CreateMatchingWorkflowCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // process err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-entityresolution"; +const client = new AWS.EntityResolution({ region: "REGION" }); + +// async/await. +try { + const data = await client.createMatchingWorkflow(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .createMatchingWorkflow(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.createMatchingWorkflow(params, (err, data) => { + // process err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-entityresolution` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. + +## Client Commands (Operations List) + +Welcome to the AWS Entity Resolution API Reference.
+ *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.
+ *+ * 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.
+ *To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the + * AWS Entity Resolution + * User Guide.
+ */ +export class EntityResolution extends EntityResolutionClient implements EntityResolution {} +createAggregatedClient(commands, EntityResolution); diff --git a/clients/client-entityresolution/src/EntityResolutionClient.ts b/clients/client-entityresolution/src/EntityResolutionClient.ts new file mode 100644 index 000000000000..0fd0534f872d --- /dev/null +++ b/clients/client-entityresolution/src/EntityResolutionClient.ts @@ -0,0 +1,362 @@ +// smithy-typescript generated code +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { + AwsAuthInputConfig, + AwsAuthResolvedConfig, + getAwsAuthPlugin, + resolveAwsAuthConfig, +} from "@aws-sdk/middleware-signing"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { Credentials as __Credentials } from "@aws-sdk/types"; +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver"; +import { getContentLengthPlugin } from "@smithy/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint"; +import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"; +import { HttpHandler as __HttpHandler } from "@smithy/protocol-http"; +import { + Client as __Client, + DefaultsMode as __DefaultsMode, + SmithyConfiguration as __SmithyConfiguration, + SmithyResolvedConfiguration as __SmithyResolvedConfiguration, +} from "@smithy/smithy-client"; +import { + BodyLengthCalculator as __BodyLengthCalculator, + Checksum as __Checksum, + ChecksumConstructor as __ChecksumConstructor, + Decoder as __Decoder, + Encoder as __Encoder, + EndpointV2 as __EndpointV2, + Hash as __Hash, + HashConstructor as __HashConstructor, + HttpHandlerOptions as __HttpHandlerOptions, + Logger as __Logger, + Provider as __Provider, + Provider, + StreamCollector as __StreamCollector, + UrlParser as __UrlParser, + UserAgent as __UserAgent, +} from "@smithy/types"; + +import { + CreateMatchingWorkflowCommandInput, + CreateMatchingWorkflowCommandOutput, +} from "./commands/CreateMatchingWorkflowCommand"; +import { + CreateSchemaMappingCommandInput, + CreateSchemaMappingCommandOutput, +} from "./commands/CreateSchemaMappingCommand"; +import { + DeleteMatchingWorkflowCommandInput, + DeleteMatchingWorkflowCommandOutput, +} from "./commands/DeleteMatchingWorkflowCommand"; +import { + DeleteSchemaMappingCommandInput, + DeleteSchemaMappingCommandOutput, +} from "./commands/DeleteSchemaMappingCommand"; +import { GetMatchIdCommandInput, GetMatchIdCommandOutput } from "./commands/GetMatchIdCommand"; +import { GetMatchingJobCommandInput, GetMatchingJobCommandOutput } from "./commands/GetMatchingJobCommand"; +import { + GetMatchingWorkflowCommandInput, + GetMatchingWorkflowCommandOutput, +} from "./commands/GetMatchingWorkflowCommand"; +import { GetSchemaMappingCommandInput, GetSchemaMappingCommandOutput } from "./commands/GetSchemaMappingCommand"; +import { ListMatchingJobsCommandInput, ListMatchingJobsCommandOutput } from "./commands/ListMatchingJobsCommand"; +import { + ListMatchingWorkflowsCommandInput, + ListMatchingWorkflowsCommandOutput, +} from "./commands/ListMatchingWorkflowsCommand"; +import { ListSchemaMappingsCommandInput, ListSchemaMappingsCommandOutput } from "./commands/ListSchemaMappingsCommand"; +import { + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "./commands/ListTagsForResourceCommand"; +import { StartMatchingJobCommandInput, StartMatchingJobCommandOutput } from "./commands/StartMatchingJobCommand"; +import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; +import { + UpdateMatchingWorkflowCommandInput, + UpdateMatchingWorkflowCommandOutput, +} from "./commands/UpdateMatchingWorkflowCommand"; +import { + ClientInputEndpointParameters, + ClientResolvedEndpointParameters, + EndpointParameters, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; + +export { __Client }; + +/** + * @public + */ +export type ServiceInputTypes = + | CreateMatchingWorkflowCommandInput + | CreateSchemaMappingCommandInput + | DeleteMatchingWorkflowCommandInput + | DeleteSchemaMappingCommandInput + | GetMatchIdCommandInput + | GetMatchingJobCommandInput + | GetMatchingWorkflowCommandInput + | GetSchemaMappingCommandInput + | ListMatchingJobsCommandInput + | ListMatchingWorkflowsCommandInput + | ListSchemaMappingsCommandInput + | ListTagsForResourceCommandInput + | StartMatchingJobCommandInput + | TagResourceCommandInput + | UntagResourceCommandInput + | UpdateMatchingWorkflowCommandInput; + +/** + * @public + */ +export type ServiceOutputTypes = + | CreateMatchingWorkflowCommandOutput + | CreateSchemaMappingCommandOutput + | DeleteMatchingWorkflowCommandOutput + | DeleteSchemaMappingCommandOutput + | GetMatchIdCommandOutput + | GetMatchingJobCommandOutput + | GetMatchingWorkflowCommandOutput + | GetSchemaMappingCommandOutput + | ListMatchingJobsCommandOutput + | ListMatchingWorkflowsCommandOutput + | ListSchemaMappingsCommandOutput + | ListTagsForResourceCommandOutput + | StartMatchingJobCommandOutput + | TagResourceCommandOutput + | UntagResourceCommandOutput + | UpdateMatchingWorkflowCommandOutput; + +/** + * @public + */ +export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> { + /** + * The HTTP handler to use. Fetch in browser and Https in Nodejs. + */ + requestHandler?: __HttpHandler; + + /** + * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface + * that computes the SHA-256 HMAC or checksum of a string or binary buffer. + * @internal + */ + sha256?: __ChecksumConstructor | __HashConstructor; + + /** + * The function that will be used to convert strings into HTTP endpoints. + * @internal + */ + urlParser?: __UrlParser; + + /** + * A function that can calculate the length of a request body. + * @internal + */ + bodyLengthChecker?: __BodyLengthCalculator; + + /** + * A function that converts a stream into an array of bytes. + * @internal + */ + streamCollector?: __StreamCollector; + + /** + * The function that will be used to convert a base64-encoded string to a byte array. + * @internal + */ + base64Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a base64-encoded string. + * @internal + */ + base64Encoder?: __Encoder; + + /** + * The function that will be used to convert a UTF8-encoded string to a byte array. + * @internal + */ + utf8Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a UTF-8 encoded string. + * @internal + */ + utf8Encoder?: __Encoder; + + /** + * The runtime environment. + * @internal + */ + runtime?: string; + + /** + * Disable dynamically changing the endpoint of the client based on the hostPrefix + * trait of an operation. + */ + disableHostPrefix?: boolean; + + /** + * Unique service identifier. + * @internal + */ + serviceId?: string; + + /** + * Enables IPv6/IPv4 dualstack endpoint. + */ + useDualstackEndpoint?: boolean | __ProviderWelcome to the AWS Entity Resolution API Reference.
+ *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.
+ *+ * 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.
+ *To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the + * AWS Entity Resolution + * User Guide.
+ */ +export class EntityResolutionClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + EntityResolutionClientResolvedConfig +> { + /** + * The resolved configuration of EntityResolutionClient class. This is resolved and normalized from the {@link EntityResolutionClientConfig | constructor configuration interface}. + */ + readonly config: EntityResolutionClientResolvedConfig; + + constructor(configuration: EntityResolutionClientConfig) { + const _config_0 = __getRuntimeConfig(configuration); + const _config_1 = resolveClientEndpointParameters(_config_0); + const _config_2 = resolveRegionConfig(_config_1); + const _config_3 = resolveEndpointConfig(_config_2); + const _config_4 = resolveRetryConfig(_config_3); + const _config_5 = resolveHostHeaderConfig(_config_4); + const _config_6 = resolveAwsAuthConfig(_config_5); + const _config_7 = resolveUserAgentConfig(_config_6); + super(_config_7); + this.config = _config_7; + this.middlewareStack.use(getRetryPlugin(this.config)); + this.middlewareStack.use(getContentLengthPlugin(this.config)); + this.middlewareStack.use(getHostHeaderPlugin(this.config)); + this.middlewareStack.use(getLoggerPlugin(this.config)); + this.middlewareStack.use(getRecursionDetectionPlugin(this.config)); + this.middlewareStack.use(getAwsAuthPlugin(this.config)); + this.middlewareStack.use(getUserAgentPlugin(this.config)); + } + + /** + * Destroy underlying resources, like sockets. It's usually not necessary to do this. + * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. + * Otherwise, sockets might stay open for quite a long time before the server terminates them. + */ + destroy(): void { + super.destroy(); + } +} diff --git a/clients/client-entityresolution/src/commands/CreateMatchingWorkflowCommand.ts b/clients/client-entityresolution/src/commands/CreateMatchingWorkflowCommand.ts new file mode 100644 index 000000000000..5476c7d8eda8 --- /dev/null +++ b/clients/client-entityresolution/src/commands/CreateMatchingWorkflowCommand.ts @@ -0,0 +1,252 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { EntityResolutionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EntityResolutionClient"; +import { CreateMatchingWorkflowInput, CreateMatchingWorkflowOutput } from "../models/models_0"; +import { de_CreateMatchingWorkflowCommand, se_CreateMatchingWorkflowCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link CreateMatchingWorkflowCommand}. + */ +export interface CreateMatchingWorkflowCommandInput extends CreateMatchingWorkflowInput {} +/** + * @public + * + * The output of {@link CreateMatchingWorkflowCommand}. + */ +export interface CreateMatchingWorkflowCommandOutput extends CreateMatchingWorkflowOutput, __MetadataBearer {} + +/** + * @public + *Creates a MatchingWorkflow object which stores the configuration of the data processing job
+ * to be run. It is important to note that there should not be a pre-existing MatchingWorkflow
+ * with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.
You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists,
+ * Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
+ *
The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits.
+ * The error message describes the limit exceeded. HTTP Status Code: 402
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class CreateMatchingWorkflowCommand extends $Command< + CreateMatchingWorkflowCommandInput, + CreateMatchingWorkflowCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateMatchingWorkflowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a schema mapping, which defines the schema of the input customer records table.
+ * The SchemaMapping also provides Entity Resolution with some metadata about the
+ * table, such as the attribute types of the columns and which columns to match on.
You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists,
+ * Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
+ *
The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits.
+ * The error message describes the limit exceeded. HTTP Status Code: 402
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class CreateSchemaMappingCommand extends $Command< + CreateSchemaMappingCommandInput, + CreateSchemaMappingCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateSchemaMappingCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the MatchingWorkflow with a given name. This operation will succeed even if a
+ * workflow with the given name does not exist.
You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class DeleteMatchingWorkflowCommand extends $Command< + DeleteMatchingWorkflowCommandInput, + DeleteMatchingWorkflowCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteMatchingWorkflowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the SchemaMapping with a given name. This operation will succeed even if a schema
+ * with the given name does not exist. This operation will fail if there is a DataIntegrationWorkflow
+ * object that references the SchemaMapping in the workflow's InputSourceConfig.
You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists,
+ * Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class DeleteSchemaMappingCommand extends $Command< + DeleteSchemaMappingCommandInput, + DeleteSchemaMappingCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteSchemaMappingCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns the corresponding Match ID of a customer record if the record has been processed.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EntityResolutionClient, GetMatchIdCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import + * // const { EntityResolutionClient, GetMatchIdCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import + * const client = new EntityResolutionClient(config); + * const input = { // GetMatchIdInput + * workflowName: "STRING_VALUE", // required + * record: { // RecordAttributeMap // required + * "You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The resource could not be found. HTTP Status Code: 404
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class GetMatchIdCommand extends $Command< + GetMatchIdCommandInput, + GetMatchIdCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetMatchIdCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets the status, metrics, and errors (if there are any) that are associated with a job.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EntityResolutionClient, GetMatchingJobCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import + * // const { EntityResolutionClient, GetMatchingJobCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import + * const client = new EntityResolutionClient(config); + * const input = { // GetMatchingJobInput + * workflowName: "STRING_VALUE", // required + * jobId: "STRING_VALUE", // required + * }; + * const command = new GetMatchingJobCommand(input); + * const response = await client.send(command); + * // { // GetMatchingJobOutput + * // jobId: "STRING_VALUE", // required + * // status: "RUNNING" || "SUCCEEDED" || "FAILED" || "QUEUED", // required + * // startTime: new Date("TIMESTAMP"), // required + * // endTime: new Date("TIMESTAMP"), + * // metrics: { // JobMetrics + * // inputRecords: Number("int"), + * // totalRecordsProcessed: Number("int"), + * // matchIDs: Number("int"), + * // recordsNotProcessed: Number("int"), + * // }, + * // errorDetails: { // ErrorDetails + * // errorMessage: "STRING_VALUE", + * // }, + * // }; + * + * ``` + * + * @param GetMatchingJobCommandInput - {@link GetMatchingJobCommandInput} + * @returns {@link GetMatchingJobCommandOutput} + * @see {@link GetMatchingJobCommandInput} for command's `input` shape. + * @see {@link GetMatchingJobCommandOutput} for command's `response` shape. + * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The resource could not be found. HTTP Status Code: 404
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class GetMatchingJobCommand extends $Command< + GetMatchingJobCommandInput, + GetMatchingJobCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetMatchingJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns the MatchingWorkflow with a given name, if it exists.
You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The resource could not be found. HTTP Status Code: 404
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class GetMatchingWorkflowCommand extends $Command< + GetMatchingWorkflowCommandInput, + GetMatchingWorkflowCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetMatchingWorkflowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns the SchemaMapping of a given name.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EntityResolutionClient, GetSchemaMappingCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import + * // const { EntityResolutionClient, GetSchemaMappingCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import + * const client = new EntityResolutionClient(config); + * const input = { // GetSchemaMappingInput + * schemaName: "STRING_VALUE", // required + * }; + * const command = new GetSchemaMappingCommand(input); + * const response = await client.send(command); + * // { // GetSchemaMappingOutput + * // schemaName: "STRING_VALUE", // required + * // schemaArn: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // mappedInputFields: [ // SchemaInputAttributes // required + * // { // SchemaInputAttribute + * // fieldName: "STRING_VALUE", // required + * // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING", // required + * // groupName: "STRING_VALUE", + * // matchKey: "STRING_VALUE", + * // }, + * // ], + * // createdAt: new Date("TIMESTAMP"), // required + * // updatedAt: new Date("TIMESTAMP"), // required + * // tags: { // TagMap + * // "You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The resource could not be found. HTTP Status Code: 404
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class GetSchemaMappingCommand extends $Command< + GetSchemaMappingCommandInput, + GetSchemaMappingCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetSchemaMappingCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists all jobs for a given workflow.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EntityResolutionClient, ListMatchingJobsCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import + * // const { EntityResolutionClient, ListMatchingJobsCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import + * const client = new EntityResolutionClient(config); + * const input = { // ListMatchingJobsInput + * workflowName: "STRING_VALUE", // required + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListMatchingJobsCommand(input); + * const response = await client.send(command); + * // { // ListMatchingJobsOutput + * // jobs: [ // JobList + * // { // JobSummary + * // jobId: "STRING_VALUE", // required + * // status: "RUNNING" || "SUCCEEDED" || "FAILED" || "QUEUED", // required + * // startTime: new Date("TIMESTAMP"), // required + * // endTime: new Date("TIMESTAMP"), + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListMatchingJobsCommandInput - {@link ListMatchingJobsCommandInput} + * @returns {@link ListMatchingJobsCommandOutput} + * @see {@link ListMatchingJobsCommandInput} for command's `input` shape. + * @see {@link ListMatchingJobsCommandOutput} for command's `response` shape. + * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The resource could not be found. HTTP Status Code: 404
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class ListMatchingJobsCommand extends $Command< + ListMatchingJobsCommandInput, + ListMatchingJobsCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListMatchingJobsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns a list of all the MatchingWorkflows that have been created for an AWS account.
You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class ListMatchingWorkflowsCommand extends $Command< + ListMatchingWorkflowsCommandInput, + ListMatchingWorkflowsCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListMatchingWorkflowsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns a list of all the SchemaMappings that have been created for an AWS account.
You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class ListSchemaMappingsCommand extends $Command< + ListSchemaMappingsCommandInput, + ListSchemaMappingsCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListSchemaMappingsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDisplays the tags associated with an AWS Entity Resolution resource. In Entity
+ * Resolution, SchemaMapping, and MatchingWorkflow can be
+ * tagged.
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The resource could not be found. HTTP Status Code: 404
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class ListTagsForResourceCommand extends $Command< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListTagsForResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackStarts the MatchingJob of a workflow. The workflow must have previously been created
+ * using the CreateMatchingWorkflow endpoint.
You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists,
+ * Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
+ *
The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits.
+ * The error message describes the limit exceeded. HTTP Status Code: 402
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The resource could not be found. HTTP Status Code: 404
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class StartMatchingJobCommand extends $Command< + StartMatchingJobCommandInput, + StartMatchingJobCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: StartMatchingJobCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAssigns 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, SchemaMapping, and
+ * MatchingWorkflow can be tagged. Tags don't have any semantic meaning to AWS
+ * and are interpreted strictly as strings of characters. You can use the
+ * TagResource 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.
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The resource could not be found. HTTP Status Code: 404
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class TagResourceCommand extends $Command< + TagResourceCommandInput, + TagResourceCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: TagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRemoves one or more tags from the specified AWS Entity Resolution resource. In Entity
+ * Resolution, SchemaMapping, and MatchingWorkflow can be
+ * tagged.
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The resource could not be found. HTTP Status Code: 404
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class UntagResourceCommand extends $Command< + UntagResourceCommandInput, + UntagResourceCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UntagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates an existing MatchingWorkflow. This method is identical to
+ * CreateMatchingWorkflow, except it uses an HTTP PUT request instead of
+ * a POST request, and the MatchingWorkflow must already exist for the
+ * method to succeed.
You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The resource could not be found. HTTP Status Code: 404
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
Base exception class for all service exceptions from EntityResolution service.
+ * + */ +export class UpdateMatchingWorkflowCommand extends $Command< + UpdateMatchingWorkflowCommandInput, + UpdateMatchingWorkflowCommandOutput, + EntityResolutionClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateMatchingWorkflowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackWelcome to the AWS Entity Resolution API Reference.
+ *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.
+ *+ * 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.
+ *To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the + * AWS Entity Resolution + * User Guide.
+ * + * @packageDocumentation + */ +export * from "./EntityResolutionClient"; +export * from "./EntityResolution"; +export * from "./commands"; +export * from "./pagination"; +export * from "./models"; + +export { EntityResolutionServiceException } from "./models/EntityResolutionServiceException"; diff --git a/clients/client-entityresolution/src/models/EntityResolutionServiceException.ts b/clients/client-entityresolution/src/models/EntityResolutionServiceException.ts new file mode 100644 index 000000000000..f70949a74add --- /dev/null +++ b/clients/client-entityresolution/src/models/EntityResolutionServiceException.ts @@ -0,0 +1,22 @@ +// smithy-typescript generated code +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 class EntityResolutionServiceException extends __ServiceException { + /** + * @internal + */ + constructor(options: __ServiceExceptionOptions) { + super(options); + Object.setPrototypeOf(this, EntityResolutionServiceException.prototype); + } +} diff --git a/clients/client-entityresolution/src/models/index.ts b/clients/client-entityresolution/src/models/index.ts new file mode 100644 index 000000000000..9eaceb12865f --- /dev/null +++ b/clients/client-entityresolution/src/models/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./models_0"; diff --git a/clients/client-entityresolution/src/models/models_0.ts b/clients/client-entityresolution/src/models/models_0.ts new file mode 100644 index 000000000000..c41ad5195cfc --- /dev/null +++ b/clients/client-entityresolution/src/models/models_0.ts @@ -0,0 +1,1220 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; + +import { EntityResolutionServiceException as __BaseException } from "./EntityResolutionServiceException"; + +/** + * @public + *You do not have sufficient access to perform this action. HTTP Status Code: 403
+ *
The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists,
+ * Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400
+ *
An object which defines an incremental run type and has only incrementalRunType as a field.
The type of incremental run. It takes only one value: IMMEDIATE.
An object containing InputSourceARN, SchemaName,
+ * and ApplyNormalization.
An Glue table ARN for the input source table.
+ */ + inputSourceARN: string | undefined; + + /** + *The name of the schema to be retrieved.
+ */ + schemaName: string | undefined; + + /** + *Normalizes the attributes defined in the schema in the input data. For example, if an
+ * attribute has an AttributeType of PHONE_NUMBER, and the data in
+ * the input table is in a format of 1234567890, Entity Resolution will normalize this field
+ * in the output to (123)-456-7890.
A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of
+ * these objects selects a column to be included in the output table, and whether the
+ * values of the column should be hashed.
A name of a column to be written to the output. This must be an InputField name
+ * in the schema mapping.
Enables the ability to hash the column values in the output.
+ */ + hashed?: boolean; +} + +/** + * @public + *A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of
+ * these objects selects a column to be included in the output table, and whether the
+ * values of the column should be hashed.
The S3 path to which Entity Resolution will write the output table.
+ */ + outputS3Path: string | undefined; + + /** + *A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of
+ * these objects selects a column to be included in the output table, and whether the
+ * values of the column should be hashed.
Customer KMS ARN for encryption at rest. If not provided, system will use an + * Entity Resolution managed KMS key.
+ */ + KMSArn?: string; + + /** + *Normalizes the attributes defined in the schema in the input data. For example, if an
+ * attribute has an AttributeType of PHONE_NUMBER, and the data in
+ * the input table is in a format of 1234567890, Entity Resolution will normalize this field
+ * in the output to (123)-456-7890.
An object containing RuleName, and MatchingKeys.
A name for the matching rule.
+ */ + ruleName: string | undefined; + + /** + *A list of MatchingKeys. The MatchingKeys must have been defined in
+ * the SchemaMapping. Two records are considered to match according to this rule if all
+ * of the MatchingKeys match.
An object which defines the list of matching rules to run and has a field Rules, which
+ * is a list of rule objects.
A list of Rule objects, each of which have fields RuleName and MatchingKeys.
You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When
+ * choosing MANY_TO_MANY, the system can match attribute across the sub-types of an attribute type. For
+ * example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches,
+ * the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if
+ * the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of
+ * the Email field of Profile B matches, the two profiles are matched on the Email type.
An object which defines the resolutionType and the ruleBasedProperties
+ *
There are two types of matching, RULE_MATCHING and ML_MATCHING
+ *
An object which defines the list of matching rules to run and has a field Rules, which
+ * is a list of rule objects.
The name of the workflow. There cannot be multiple DataIntegrationWorkflows with the same name.
A description of the workflow.
+ */ + description?: string; + + /** + *A list of InputSource objects, which have the fields InputSourceARN and
+ * SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path,
+ * ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties
+ *
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role + * to create resources on your behalf as part of workflow execution.
+ */ + roleArn: string | undefined; + + /** + *The tags used to organize, track, or control access for this resource.
+ */ + tags?: RecordThe name of the workflow.
+ */ + workflowName: string | undefined; + + /** + *The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
A description of the workflow.
+ */ + description?: string; + + /** + *A list of InputSource objects, which have the fields InputSourceARN and
+ * SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path,
+ * ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties
+ *
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role + * to create resources on your behalf as part of workflow execution.
+ */ + roleArn: string | undefined; +} + +/** + * @public + *The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits.
+ * The error message describes the limit exceeded. HTTP Status Code: 402
+ *
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500
+ *
The request was denied due to request throttling. HTTP Status Code: 429
+ *
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400
+ *
An object containing FieldField, Type, GroupName,
+ * and MatchKey.
A string containing the field name.
+ */ + fieldName: string | undefined; + + /** + *The type of the attribute, selected from a list of values.
+ */ + type: SchemaAttributeType | string | undefined; + + /** + *Instruct Entity Resolution to combine several columns into a unified column with the
+ * identical attribute type. For example, when working with columns such as first_name,
+ * middle_name, and last_name, assigning them a common GroupName will prompt
+ * Entity Resolution to concatenate them into a single value.
A key that allows grouping of multiple input attributes into a unified matching group.
+ * For example, let's consider a scenario where the source table contains various addresses,
+ * such as business_address and shipping_address. By assigning the MatchKey
+ * Address' to both attributes, Entity Resolution will match records
+ * across these fields to create a consolidated matching group. If no MatchKey is
+ * specified for a column, it won't be utilized for matching purposes but will still be
+ * included in the output table.
The name of the schema. There cannot be multiple SchemaMappings with the
+ * same name.
A description of the schema.
+ */ + description?: string; + + /** + *A list of MappedInputFields. Each MappedInputField corresponds
+ * to a column the source data table, and contains column name plus additional information
+ * that Entity Resolution uses for matching.
The tags used to organize, track, or control access for this resource.
+ */ + tags?: RecordThe name of the schema.
+ */ + schemaName: string | undefined; + + /** + *The ARN (Amazon Resource Name) that Entity Resolution generated for the
+ * SchemaMapping.
A description of the schema.
+ */ + description: string | undefined; + + /** + *A list of MappedInputFields. Each MappedInputField corresponds
+ * to a column the source data table, and contains column name plus additional information
+ * that Entity Resolution uses for matching.
The name of the workflow to be retrieved.
+ */ + workflowName: string | undefined; +} + +/** + * @public + */ +export interface DeleteMatchingWorkflowOutput { + /** + *A successful operation message.
+ */ + message: string | undefined; +} + +/** + * @public + */ +export interface DeleteSchemaMappingInput { + /** + *The name of the schema to delete.
+ */ + schemaName: string | undefined; +} + +/** + * @public + */ +export interface DeleteSchemaMappingOutput { + /** + *A successful operation message.
+ */ + message: string | undefined; +} + +/** + * @public + */ +export interface GetMatchIdInput { + /** + *The name of the workflow.
+ */ + workflowName: string | undefined; + + /** + *The record to fetch the Match ID for.
+ */ + record: RecordThe unique identifiers for this group of match records.
+ */ + matchId?: string; +} + +/** + * @public + *The resource could not be found. HTTP Status Code: 404
+ *
The name of the workflow.
+ */ + workflowName: string | undefined; + + /** + *The ID of the job.
+ */ + jobId: string | undefined; +} + +/** + * @public + *An object containing an error message, if there was an error.
+ */ +export interface ErrorDetails { + /** + *The error message from the job, if there is one.
+ */ + errorMessage?: string; +} + +/** + * @public + *An object containing InputRecords, TotalRecordsProcessed,
+ * MatchIDs, and RecordsNotProcessed.
The total number of input records.
+ */ + inputRecords?: number; + + /** + *The total number of records processed.
+ */ + totalRecordsProcessed?: number; + + /** + *The total number of matchIDs generated.
The total number of records that did not get processed,
+ */ + recordsNotProcessed?: number; +} + +/** + * @public + * @enum + */ +export const JobStatus = { + FAILED: "FAILED", + QUEUED: "QUEUED", + RUNNING: "RUNNING", + SUCCEEDED: "SUCCEEDED", +} as const; + +/** + * @public + */ +export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus]; + +/** + * @public + */ +export interface GetMatchingJobOutput { + /** + *The ID of the job.
+ */ + jobId: string | undefined; + + /** + *The current status of the job. Either running, succeeded,
+ * queued, or failed.
The time at which the job was started.
+ */ + startTime: Date | undefined; + + /** + *The time at which the job has finished.
+ */ + endTime?: Date; + + /** + *Metrics associated with the execution, specifically total records processed, + * unique IDs generated, and records the execution skipped.
+ */ + metrics?: JobMetrics; + + /** + *An object containing an error message, if there was an error.
+ */ + errorDetails?: ErrorDetails; +} + +/** + * @public + */ +export interface GetMatchingWorkflowInput { + /** + *The name of the workflow.
+ */ + workflowName: string | undefined; +} + +/** + * @public + */ +export interface GetMatchingWorkflowOutput { + /** + *The name of the workflow.
+ */ + workflowName: string | undefined; + + /** + *The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
A description of the workflow.
+ */ + description?: string; + + /** + *A list of InputSource objects, which have the fields InputSourceARN and
+ * SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path,
+ * ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties
+ *
The timestamp of when the workflow was created.
+ */ + createdAt: Date | undefined; + + /** + *The timestamp of when the workflow was last updated.
+ */ + updatedAt: Date | undefined; + + /** + *An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access + * resources on your behalf.
+ */ + roleArn: string | undefined; + + /** + *The tags used to organize, track, or control access for this resource.
+ */ + tags?: RecordThe name of the schema to be retrieved.
+ */ + schemaName: string | undefined; +} + +/** + * @public + */ +export interface GetSchemaMappingOutput { + /** + *The name of the schema.
+ */ + schemaName: string | undefined; + + /** + *The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
+ */ + schemaArn: string | undefined; + + /** + *A description of the schema.
+ */ + description?: string; + + /** + *A list of MappedInputFields. Each MappedInputField corresponds
+ * to a column the source data table, and contains column name plus additional information
+ * Venice uses for matching.
The timestamp of when the SchemaMapping was created.
The timestamp of when the SchemaMapping was last updated.
The tags used to organize, track, or control access for this resource.
+ */ + tags?: RecordThe name of the workflow to be retrieved.
+ */ + workflowName: string | undefined; + + /** + *The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
+ */ + maxResults?: number; +} + +/** + * @public + *An object containing the JobId, Status,
+ * StartTime, and EndTime of a job.
The ID of the job.
+ */ + jobId: string | undefined; + + /** + *The current status of the job. Either running, succeeded,
+ * queued, or failed.
The time at which the job was started.
+ */ + startTime: Date | undefined; + + /** + *The time at which the job has finished.
+ */ + endTime?: Date; +} + +/** + * @public + */ +export interface ListMatchingJobsOutput { + /** + *A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.
+ */ + jobs?: JobSummary[]; + + /** + *The pagination token from the previous ListSchemaMappings API call.
The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
+ */ + maxResults?: number; +} + +/** + * @public + *A list of MatchingWorkflowSummary objects, each of which contain the fields
+ * WorkflowName, WorkflowArn, CreatedAt, UpdatedAt.
The name of the workflow.
+ */ + workflowName: string | undefined; + + /** + *The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
The timestamp of when the workflow was created.
+ */ + createdAt: Date | undefined; + + /** + *The timestamp of when the workflow was last updated.
+ */ + updatedAt: Date | undefined; +} + +/** + * @public + */ +export interface ListMatchingWorkflowsOutput { + /** + *A list of MatchingWorkflowSummary objects, each of which contain the fields
+ * WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.
The pagination token from the previous ListSchemaMappings API call.
The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
+ */ + maxResults?: number; +} + +/** + * @public + *An object containing SchemaName, SchemaArn,
+ * CreatedAt, andUpdatedAt.
The name of the schema.
+ */ + schemaName: string | undefined; + + /** + *The ARN (Amazon Resource Name) that Entity Resolution generated for the
+ * SchemaMapping.
The timestamp of when the SchemaMapping was created.
The timestamp of when the SchemaMapping was last updated.
A list of SchemaMappingSummary objects, each of which contain the fields
+ * SchemaName, SchemaArn, CreatedAt, UpdatedAt.
The pagination token from the previous ListDomains API call.
The ARN of the resource for which you want to view tags.
+ */ + resourceArn: string | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceOutput { + /** + *The tags used to organize, track, or control access for this resource.
+ */ + tags: RecordThe name of the matching job to be retrieved.
+ */ + workflowName: string | undefined; +} + +/** + * @public + */ +export interface StartMatchingJobOutput { + /** + *The ID of the job.
+ */ + jobId: string | undefined; +} + +/** + * @public + */ +export interface TagResourceInput { + /** + *The ARN of the resource for which you want to view tags.
+ */ + resourceArn: string | undefined; + + /** + *The tags used to organize, track, or control access for this resource.
+ */ + tags: RecordThe ARN of the resource for which you want to untag.
+ */ + resourceArn: string | undefined; + + /** + *The list of tag keys to remove from the resource.
+ */ + tagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface UntagResourceOutput {} + +/** + * @public + */ +export interface UpdateMatchingWorkflowInput { + /** + *The name of the workflow to be retrieved.
+ */ + workflowName: string | undefined; + + /** + *A description of the workflow.
+ */ + description?: string; + + /** + *A list of InputSource objects, which have the fields InputSourceARN and
+ * SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path,
+ * ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties
+ *
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role + * to create resources on your behalf as part of workflow execution.
+ */ + roleArn: string | undefined; +} + +/** + * @public + */ +export interface UpdateMatchingWorkflowOutput { + /** + *The name of the workflow.
+ */ + workflowName: string | undefined; + + /** + *A description of the workflow.
+ */ + description?: string; + + /** + *A list of InputSource objects, which have the fields InputSourceARN and
+ * SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path,
+ * ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties
+ *
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role + * to create resources on your behalf as part of workflow execution.
+ */ + roleArn: string | undefined; +} + +/** + * @internal + */ +export const GetMatchIdInputFilterSensitiveLog = (obj: GetMatchIdInput): any => ({ + ...obj, + ...(obj.record && { record: SENSITIVE_STRING }), +}); diff --git a/clients/client-entityresolution/src/pagination/Interfaces.ts b/clients/client-entityresolution/src/pagination/Interfaces.ts new file mode 100644 index 000000000000..d7aafac3c590 --- /dev/null +++ b/clients/client-entityresolution/src/pagination/Interfaces.ts @@ -0,0 +1,11 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@smithy/types"; + +import { EntityResolutionClient } from "../EntityResolutionClient"; + +/** + * @public + */ +export interface EntityResolutionPaginationConfiguration extends PaginationConfiguration { + client: EntityResolutionClient; +} diff --git a/clients/client-entityresolution/src/pagination/ListMatchingJobsPaginator.ts b/clients/client-entityresolution/src/pagination/ListMatchingJobsPaginator.ts new file mode 100644 index 000000000000..7619910764c5 --- /dev/null +++ b/clients/client-entityresolution/src/pagination/ListMatchingJobsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + ListMatchingJobsCommand, + ListMatchingJobsCommandInput, + ListMatchingJobsCommandOutput, +} from "../commands/ListMatchingJobsCommand"; +import { EntityResolutionClient } from "../EntityResolutionClient"; +import { EntityResolutionPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: EntityResolutionClient, + input: ListMatchingJobsCommandInput, + ...args: any +): PromiseWelcome to the AWS Entity Resolution API Reference.
\nAWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities \n that enable developers and analysts at advertising and marketing companies to build an accurate and \n complete view of their consumers.
\n\n With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers, \n such as name, email address, and phone number. This holds true even when these records have incomplete or \n conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a \n customer relationship management (CRM) system, which includes account information like first name, last name, \n postal address, phone number, and email address, with a source record from a marketing system containing \n campaign information, such as username and email address.
\nTo learn more about AWS Entity Resolution concepts, procedures, and best practices, see the\n AWS Entity Resolution \n User Guide.
", + "smithy.api#title": "AWS EntityResolution", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://entityresolution-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://entityresolution-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://entityresolution.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://entityresolution.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://entityresolution.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://entityresolution.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://entityresolution.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": false, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.entityresolution#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.entityresolution#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "You do not have sufficient access to perform this action. HTTP Status Code: 403\n
The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, \n Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400\n
Creates a MatchingWorkflow object which stores the configuration of the data processing job \n to be run. It is important to note that there should not be a pre-existing MatchingWorkflow \n with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.
The name of the workflow. There cannot be multiple DataIntegrationWorkflows with the same name.
A description of the workflow.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#InputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.entityresolution#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#CreateMatchingWorkflowOutput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#required": {} + } + }, + "workflowArn": { + "target": "com.amazonaws.entityresolution#MatchingWorkflowArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
A description of the workflow.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#InputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#CreateSchemaMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#CreateSchemaMappingInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#CreateSchemaMappingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#ConflictException" + }, + { + "target": "com.amazonaws.entityresolution#ExceedsLimitException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a schema mapping, which defines the schema of the input customer records table.\n The SchemaMapping also provides Entity Resolution with some metadata about the\n table, such as the attribute types of the columns and which columns to match on.
The name of the schema. There cannot be multiple SchemaMappings with the\n same name.
A description of the schema.
" + } + }, + "mappedInputFields": { + "target": "com.amazonaws.entityresolution#SchemaInputAttributes", + "traits": { + "smithy.api#documentation": "A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n that Entity Resolution uses for matching.
The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#CreateSchemaMappingOutput": { + "type": "structure", + "members": { + "schemaName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the schema.
", + "smithy.api#required": {} + } + }, + "schemaArn": { + "target": "com.amazonaws.entityresolution#SchemaMappingArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the\n SchemaMapping.
A description of the schema.
", + "smithy.api#required": {} + } + }, + "mappedInputFields": { + "target": "com.amazonaws.entityresolution#SchemaInputAttributes", + "traits": { + "smithy.api#documentation": "A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n that Entity Resolution uses for matching.
Deletes the MatchingWorkflow with a given name. This operation will succeed even if a \n workflow with the given name does not exist.
The name of the workflow to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#DeleteMatchingWorkflowOutput": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A successful operation message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#DeleteSchemaMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#DeleteSchemaMappingInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#DeleteSchemaMappingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#ConflictException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the SchemaMapping with a given name. This operation will succeed even if a schema \n with the given name does not exist. This operation will fail if there is a DataIntegrationWorkflow \n object that references the SchemaMapping in the workflow's InputSourceConfig.
The name of the schema to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#DeleteSchemaMappingOutput": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A successful operation message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 255 + } + } + }, + "com.amazonaws.entityresolution#EntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9-]*$" + } + }, + "com.amazonaws.entityresolution#ErrorDetails": { + "type": "structure", + "members": { + "errorMessage": { + "target": "com.amazonaws.entityresolution#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message from the job, if there is one.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing an error message, if there was an error.
" + } + }, + "com.amazonaws.entityresolution#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.entityresolution#ExceedsLimitException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.entityresolution#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. \n The error message describes the limit exceeded. HTTP Status Code: 402\n
Returns the corresponding Match ID of a customer record if the record has been processed.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/matchingworkflows/{workflowName}/matches" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.entityresolution#GetMatchIdInput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "record": { + "target": "com.amazonaws.entityresolution#RecordAttributeMap", + "traits": { + "smithy.api#documentation": "The record to fetch the Match ID for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#GetMatchIdOutput": { + "type": "structure", + "members": { + "matchId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifiers for this group of match records.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#GetMatchingJobInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#GetMatchingJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the status, metrics, and errors (if there are any) that are associated with a job.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/matchingworkflows/{workflowName}/jobs/{jobId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingJobInput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "jobId": { + "target": "com.amazonaws.entityresolution#JobId", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingJobOutput": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.entityresolution#JobId", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.entityresolution#JobStatus", + "traits": { + "smithy.api#documentation": "The current status of the job. Either running, succeeded, \n queued, or failed.
The time at which the job was started.
", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the job has finished.
" + } + }, + "metrics": { + "target": "com.amazonaws.entityresolution#JobMetrics", + "traits": { + "smithy.api#documentation": "Metrics associated with the execution, specifically total records processed, \n unique IDs generated, and records the execution skipped.
" + } + }, + "errorDetails": { + "target": "com.amazonaws.entityresolution#ErrorDetails", + "traits": { + "smithy.api#documentation": "An object containing an error message, if there was an error.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#GetMatchingWorkflowInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#GetMatchingWorkflowOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the MatchingWorkflow with a given name, if it exists.
The name of the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingWorkflowOutput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#required": {} + } + }, + "workflowArn": { + "target": "com.amazonaws.entityresolution#MatchingWorkflowArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
A description of the workflow.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#InputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties\n
The timestamp of when the workflow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the workflow was last updated.
", + "smithy.api#required": {} + } + }, + "incrementalRunConfig": { + "target": "com.amazonaws.entityresolution#IncrementalRunConfig", + "traits": { + "smithy.api#documentation": "An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access \n resources on your behalf.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.entityresolution#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#GetSchemaMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#GetSchemaMappingInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#GetSchemaMappingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the SchemaMapping of a given name.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/schemas/{schemaName}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.entityresolution#GetSchemaMappingInput": { + "type": "structure", + "members": { + "schemaName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the schema to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#GetSchemaMappingOutput": { + "type": "structure", + "members": { + "schemaName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the schema.
", + "smithy.api#required": {} + } + }, + "schemaArn": { + "target": "com.amazonaws.entityresolution#SchemaMappingArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "A description of the schema.
" + } + }, + "mappedInputFields": { + "target": "com.amazonaws.entityresolution#SchemaInputAttributes", + "traits": { + "smithy.api#documentation": "A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n Venice uses for matching.
The timestamp of when the SchemaMapping was created.
The timestamp of when the SchemaMapping was last updated.
The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#IncrementalRunConfig": { + "type": "structure", + "members": { + "incrementalRunType": { + "target": "com.amazonaws.entityresolution#IncrementalRunType", + "traits": { + "smithy.api#documentation": "The type of incremental run. It takes only one value: IMMEDIATE.
An object which defines an incremental run type and has only incrementalRunType as a field.
An Glue table ARN for the input source table.
", + "smithy.api#pattern": "^arn:aws:.*:.*:[0-9]+:.*$", + "smithy.api#required": {} + } + }, + "schemaName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the schema to be retrieved.
", + "smithy.api#required": {} + } + }, + "applyNormalization": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Normalizes the attributes defined in the schema in the input data. For example, if an\n attribute has an AttributeType of PHONE_NUMBER, and the data in\n the input table is in a format of 1234567890, Entity Resolution will normalize this field\n in the output to (123)-456-7890.
An object containing InputSourceARN, SchemaName, \n and ApplyNormalization.
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500\n
The total number of input records.
" + } + }, + "totalRecordsProcessed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of records processed.
" + } + }, + "matchIDs": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of matchIDs generated.
The total number of records that did not get processed,
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing InputRecords, TotalRecordsProcessed, \n MatchIDs, and RecordsNotProcessed.
The ID of the job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.entityresolution#JobStatus", + "traits": { + "smithy.api#documentation": "The current status of the job. Either running, succeeded, \n queued, or failed.
The time at which the job was started.
", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the job has finished.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing the JobId, Status, \n StartTime, and EndTime of a job.
Lists all jobs for a given workflow.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/matchingworkflows/{workflowName}/jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.entityresolution#ListMatchingJobsInput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.entityresolution#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#ListMatchingJobsOutput": { + "type": "structure", + "members": { + "jobs": { + "target": "com.amazonaws.entityresolution#JobList", + "traits": { + "smithy.api#documentation": "A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.
" + } + }, + "nextToken": { + "target": "com.amazonaws.entityresolution#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token from the previous ListSchemaMappings API call.
Returns a list of all the MatchingWorkflows that have been created for an AWS account.
The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "max": 25 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#ListMatchingWorkflowsOutput": { + "type": "structure", + "members": { + "workflowSummaries": { + "target": "com.amazonaws.entityresolution#MatchingWorkflowList", + "traits": { + "smithy.api#documentation": "A list of MatchingWorkflowSummary objects, each of which contain the fields \n WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.
The pagination token from the previous ListSchemaMappings API call.
Returns a list of all the SchemaMappings that have been created for an AWS account.
The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "max": 25 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#ListSchemaMappingsOutput": { + "type": "structure", + "members": { + "schemaList": { + "target": "com.amazonaws.entityresolution#SchemaMappingList", + "traits": { + "smithy.api#documentation": "A list of SchemaMappingSummary objects, each of which contain the fields \n SchemaName, SchemaArn, CreatedAt, UpdatedAt.
The pagination token from the previous ListDomains API call.
Displays the tags associated with an AWS Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.
The ARN of the resource for which you want to view tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.entityresolution#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#MatchingKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#AttributeName" + } + }, + "com.amazonaws.entityresolution#MatchingWorkflowArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(matchingworkflow/.*)$" + } + }, + "com.amazonaws.entityresolution#MatchingWorkflowList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#MatchingWorkflowSummary" + } + }, + "com.amazonaws.entityresolution#MatchingWorkflowSummary": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#required": {} + } + }, + "workflowArn": { + "target": "com.amazonaws.entityresolution#MatchingWorkflowArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
The timestamp of when the workflow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the workflow was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of MatchingWorkflowSummary objects, each of which contain the fields \n WorkflowName, WorkflowArn, CreatedAt, UpdatedAt.
A name of a column to be written to the output. This must be an InputField name \n in the schema mapping.
Enables the ability to hash the column values in the output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.
The S3 path to which Entity Resolution will write the output table.
", + "smithy.api#pattern": "^s3://([^/]+)/?(.*?([^/]+)/?)$", + "smithy.api#required": {} + } + }, + "output": { + "target": "com.amazonaws.entityresolution#OutputAttributes", + "traits": { + "smithy.api#documentation": "A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.
Customer KMS ARN for encryption at rest. If not provided, system will use an \n Entity Resolution managed KMS key.
" + } + }, + "applyNormalization": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Normalizes the attributes defined in the schema in the input data. For example, if an\n attribute has an AttributeType of PHONE_NUMBER, and the data in\n the input table is in a format of 1234567890, Entity Resolution will normalize this field\n in the output to (123)-456-7890.
A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.
There are two types of matching, RULE_MATCHING and ML_MATCHING\n
An object which defines the list of matching rules to run and has a field Rules, which \n is a list of rule objects.
An object which defines the resolutionType and the ruleBasedProperties\n
The resource could not be found. HTTP Status Code: 404\n
A name for the matching rule.
", + "smithy.api#length": { + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9- \\t]*$", + "smithy.api#required": {} + } + }, + "matchingKeys": { + "target": "com.amazonaws.entityresolution#MatchingKeys", + "traits": { + "smithy.api#documentation": "A list of MatchingKeys. The MatchingKeys must have been defined in \n the SchemaMapping. Two records are considered to match according to this rule if all \n of the MatchingKeys match.
An object containing RuleName, and MatchingKeys.
A list of Rule objects, each of which have fields RuleName and MatchingKeys.
You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When \n choosing MANY_TO_MANY, the system can match attribute across the sub-types of an attribute type. For \n example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, \n the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if \n the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of \n the Email field of Profile B matches, the two profiles are matched on the Email type.
An object which defines the list of matching rules to run and has a field Rules, which \n is a list of rule objects.
A string containing the field name.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.entityresolution#SchemaAttributeType", + "traits": { + "smithy.api#documentation": "The type of the attribute, selected from a list of values.
", + "smithy.api#required": {} + } + }, + "groupName": { + "target": "com.amazonaws.entityresolution#AttributeName", + "traits": { + "smithy.api#documentation": "Instruct Entity Resolution to combine several columns into a unified column with the\n identical attribute type. For example, when working with columns such as first_name,\n middle_name, and last_name, assigning them a common GroupName will prompt\n Entity Resolution to concatenate them into a single value.
A key that allows grouping of multiple input attributes into a unified matching group.\n For example, let's consider a scenario where the source table contains various addresses,\n such as business_address and shipping_address. By assigning the MatchKey\n Address' to both attributes, Entity Resolution will match records\n across these fields to create a consolidated matching group. If no MatchKey is\n specified for a column, it won't be utilized for matching purposes but will still be\n included in the output table.
An object containing FieldField, Type, GroupName, \n and MatchKey.
The name of the schema.
", + "smithy.api#required": {} + } + }, + "schemaArn": { + "target": "com.amazonaws.entityresolution#SchemaMappingArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the\n SchemaMapping.
The timestamp of when the SchemaMapping was created.
The timestamp of when the SchemaMapping was last updated.
An object containing SchemaName, SchemaArn, \n CreatedAt, andUpdatedAt.
Starts the MatchingJob of a workflow. The workflow must have previously been created \n using the CreateMatchingWorkflow endpoint.
The name of the matching job to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#StartMatchingJobOutput": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.entityresolution#JobId", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.entityresolution#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.entityresolution#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.entityresolution#TagKey" + }, + "value": { + "target": "com.amazonaws.entityresolution#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.entityresolution#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution\n resource. Tags can help you organize and categorize your resources. You can also use them\n to scope user permissions by granting a user permission to access or change only resources\n with certain tag values. In Entity Resolution, SchemaMapping, and\n MatchingWorkflow can be tagged. Tags don't have any semantic meaning to AWS\n and are interpreted strictly as strings of characters. You can use the\n TagResource action with a resource that already has tags. If you specify a\n new tag key, this tag is appended to the list of tags associated with the resource. If you\n specify a tag key that is already associated with the resource, the new tag value that you\n specify replaces the previous value for that tag.
The ARN of the resource for which you want to view tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.entityresolution#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#TagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.entityresolution#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.entityresolution#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling. HTTP Status Code: 429\n
Removes one or more tags from the specified AWS Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.
The ARN of the resource for which you want to untag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.entityresolution#TagKeyList", + "traits": { + "smithy.api#documentation": "The list of tag keys to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#UntagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#UpdateMatchingWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#UpdateMatchingWorkflowInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#UpdateMatchingWorkflowOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing MatchingWorkflow. This method is identical to \n CreateMatchingWorkflow, except it uses an HTTP PUT request instead of \n a POST request, and the MatchingWorkflow must already exist for the \n method to succeed.
The name of the workflow to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "A description of the workflow.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#InputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#UpdateMatchingWorkflowOutput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "A description of the workflow.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#InputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.entityresolution#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400\n