JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.entityresolution

Interface AWSEntityResolution

  • All Known Subinterfaces:
    AWSEntityResolutionAsync
    All Known Implementing Classes:
    AbstractAWSEntityResolution, AbstractAWSEntityResolutionAsync, AWSEntityResolutionAsyncClient, AWSEntityResolutionClient 

    @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSEntityResolution
    Interface for accessing AWSEntityResolution.

    Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSEntityResolution instead.

    Welcome to the Entity Resolution API Reference.

    Entity Resolution is an Amazon Web Services 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 Entity Resolution, you can match source records containing consumer identifiers, such as name, email address, and phone number. This is true even when these records have incomplete or conflicting identifiers. For example, Entity Resolution can effectively match a source record from a customer relationship management (CRM) system with a source record from a marketing system containing campaign information.

    To learn more about Entity Resolution concepts, procedures, and best practices, see the Entity Resolution User Guide.

    • Method Detail

      • addPolicyStatement

        AddPolicyStatementResult addPolicyStatement(AddPolicyStatementRequest addPolicyStatementRequest)

        Adds a policy statement object. To retrieve a list of existing policy statements, use the GetPolicy API.

        Parameters:
        addPolicyStatementRequest -
        Returns:
        Result of the AddPolicyStatement operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        ResourceNotFoundException - The resource could not be found.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • createIdMappingWorkflow

        CreateIdMappingWorkflowResult createIdMappingWorkflow(CreateIdMappingWorkflowRequest createIdMappingWorkflowRequest)

        Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.

        Parameters:
        createIdMappingWorkflowRequest -
        Returns:
        Result of the CreateIdMappingWorkflow operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • createIdNamespace

        CreateIdNamespaceResult createIdNamespace(CreateIdNamespaceRequest createIdNamespaceRequest)

        Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.

        Parameters:
        createIdNamespaceRequest -
        Returns:
        Result of the CreateIdNamespace operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • createMatchingWorkflow

        CreateMatchingWorkflowResult createMatchingWorkflow(CreateMatchingWorkflowRequest createMatchingWorkflowRequest)

        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.

        Parameters:
        createMatchingWorkflowRequest -
        Returns:
        Result of the CreateMatchingWorkflow operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • createSchemaMapping

        CreateSchemaMappingResult createSchemaMapping(CreateSchemaMappingRequest createSchemaMappingRequest)

        Creates 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.

        Parameters:
        createSchemaMappingRequest -
        Returns:
        Result of the CreateSchemaMapping operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • deleteIdMappingWorkflow

        DeleteIdMappingWorkflowResult deleteIdMappingWorkflow(DeleteIdMappingWorkflowRequest deleteIdMappingWorkflowRequest)

        Deletes the IdMappingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.

        Parameters:
        deleteIdMappingWorkflowRequest -
        Returns:
        Result of the DeleteIdMappingWorkflow operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • deleteMatchingWorkflow

        DeleteMatchingWorkflowResult deleteMatchingWorkflow(DeleteMatchingWorkflowRequest deleteMatchingWorkflowRequest)

        Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.

        Parameters:
        deleteMatchingWorkflowRequest -
        Returns:
        Result of the DeleteMatchingWorkflow operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • deleteSchemaMapping

        DeleteSchemaMappingResult deleteSchemaMapping(DeleteSchemaMappingRequest deleteSchemaMappingRequest)

        Deletes 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 MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.

        Parameters:
        deleteSchemaMappingRequest -
        Returns:
        Result of the DeleteSchemaMapping operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • putPolicy

        PutPolicyResult putPolicy(PutPolicyRequest putPolicyRequest)

        Updates the resource-based policy.

        Parameters:
        putPolicyRequest -
        Returns:
        Result of the PutPolicy operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        ResourceNotFoundException - The resource could not be found.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • startIdMappingJob

        StartIdMappingJobResult startIdMappingJob(StartIdMappingJobRequest startIdMappingJobRequest)

        Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.

        Parameters:
        startIdMappingJobRequest -
        Returns:
        Result of the StartIdMappingJob operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        ResourceNotFoundException - The resource could not be found.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • startMatchingJob

        StartMatchingJobResult startMatchingJob(StartMatchingJobRequest startMatchingJobRequest)

        Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.

        Parameters:
        startMatchingJobRequest -
        Returns:
        Result of the StartMatchingJob operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        ResourceNotFoundException - The resource could not be found.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ExceedsLimitException - The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • tagResource

        TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

        Assigns one or more tags (key-value pairs) to the specified 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 Amazon Web Services 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.

        Parameters:
        tagResourceRequest -
        Returns:
        Result of the TagResource operation returned by the service.
        Throws:
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        ResourceNotFoundException - The resource could not be found.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • untagResource

        UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

        Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.

        Parameters:
        untagResourceRequest -
        Returns:
        Result of the UntagResource operation returned by the service.
        Throws:
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        ResourceNotFoundException - The resource could not be found.
        See Also:
        AWS API Documentation

      • updateIdMappingWorkflow

        UpdateIdMappingWorkflowResult updateIdMappingWorkflow(UpdateIdMappingWorkflowRequest updateIdMappingWorkflowRequest)

        Updates an existing IdMappingWorkflow. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed.

        Parameters:
        updateIdMappingWorkflowRequest -
        Returns:
        Result of the UpdateIdMappingWorkflow operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        ResourceNotFoundException - The resource could not be found.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • updateMatchingWorkflow

        UpdateMatchingWorkflowResult updateMatchingWorkflow(UpdateMatchingWorkflowRequest updateMatchingWorkflowRequest)

        Updates 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.

        Parameters:
        updateMatchingWorkflowRequest -
        Returns:
        Result of the UpdateMatchingWorkflow operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        ResourceNotFoundException - The resource could not be found.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • updateSchemaMapping

        UpdateSchemaMappingResult updateSchemaMapping(UpdateSchemaMappingRequest updateSchemaMappingRequest)

        Updates a schema mapping.

        A schema is immutable if it is being used by a workflow. Therefore, you can't update a schema mapping if it's associated with a workflow.

        Parameters:
        updateSchemaMappingRequest -
        Returns:
        Result of the UpdateSchemaMapping operation returned by the service.
        Throws:
        ThrottlingException - The request was denied due to request throttling.
        InternalServerException - This exception occurs when there is an internal failure in the Entity Resolution service.
        ResourceNotFoundException - The resource could not be found.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - 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.
        ValidationException - The input fails to satisfy the constraints specified by Entity Resolution.
        See Also:
        AWS API Documentation

      • shutdown

        void shutdown()
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

      • getCachedResponseMetadata

        ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /