Amazon Entity Resolution Entity Resolution Idnamespaces API

openapi: 3.2.0
info:
  title: AWS EntityResolution Idnamespaces API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for AWS EntityResolution. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://entityresolution.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Idnamespaces
paths:
  /idnamespaces:
    post:
      operationId: CreateIdNamespace
      summary: Create Id Namespace
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIdNamespaceOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '402':
          description: ExceedsLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceedsLimitException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIdNamespaceInput'
      tags:
      - Idnamespaces
    get:
      operationId: ListIdNamespaces
      summary: List Id Namespaces
      description: Returns a list of all ID namespaces.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIdNamespacesOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListIdNamespacesInput'
      tags:
      - Idnamespaces
  /idnamespaces/{idNamespaceName}:
    delete:
      operationId: DeleteIdNamespace
      summary: Delete Id Namespace
      description: Deletes the IdNamespace with a given name. This operation returns a ResourceNotFoundException if an ID namespace with the given name does not exist.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteIdNamespaceOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteIdNamespaceInput'
      tags:
      - Idnamespaces
    get:
      operationId: GetIdNamespace
      summary: Get Id Namespace
      description: Returns the IdNamespace with a given name, if it exists.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIdNamespaceOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetIdNamespaceInput'
      tags:
      - Idnamespaces
    put:
      operationId: UpdateIdNamespace
      summary: Update Id Namespace
      description: Updates an existing ID namespace.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateIdNamespaceOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateIdNamespaceInput'
      tags:
      - Idnamespaces
components:
  schemas:
    ExceedsLimitException:
      type: object
      properties:
        message:
          type: string
        quotaName:
          type: string
          description: The name of the quota that has been breached.
        quotaValue:
          type: integer
          description: The current quota value for the customers.
    UpdateIdNamespaceOutput:
      type: object
      properties:
        idNamespaceName:
          type: string
          description: The name of the ID namespace.
        idNamespaceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ID namespace.
        description:
          type: string
          description: The description of the ID namespace.
        inputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceInputSource'
          description: A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
        idMappingWorkflowProperties:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceIdMappingWorkflowProperties'
          description: Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
        type:
          type: string
          enum:
          - SOURCE
          - TARGET
          description: 'The type of ID namespace. There are two types: SOURCE and TARGET. The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow. The TARGET contains a configuration of targetId to which all sourceIds will resolve to.'
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.
        createdAt:
          type: string
          description: The timestamp of when the ID namespace was created.
        updatedAt:
          type: string
          description: The timestamp of when the ID namespace was last updated.
      required:
      - idNamespaceName
      - idNamespaceArn
      - type
      - createdAt
      - updatedAt
    NamespaceRuleBasedProperties:
      type: object
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
          description: The rules for the ID namespace.
        ruleDefinitionTypes:
          type: array
          items:
            type: string
            enum:
            - SOURCE
            - TARGET
          description: The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.
        attributeMatchingModel:
          type: string
          enum:
          - ONE_TO_ONE
          - MANY_TO_MANY
          description: The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel. If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B. If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the
        recordMatchingModels:
          type: array
          items:
            type: string
            enum:
            - ONE_SOURCE_TO_ONE_TARGET
            - MANY_SOURCE_TO_ONE_TARGET
          description: The type of matching record that is allowed to be used in an ID mapping workflow. If the value is set to ONE_SOURCE_TO_ONE_TARGET, only one record in the source is matched to one record in the target. If the value is set to MANY_SOURCE_TO_ONE_TARGET, all matching records in the source are matched to one record in the target.
    ListIdNamespacesOutput:
      type: object
      properties:
        idNamespaceSummaries:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceSummary'
          description: A list of IdNamespaceSummaries objects.
        nextToken:
          type: string
          description: The pagination token from the previous API call.
    IdNamespaceIdMappingWorkflowMetadata:
      type: object
      properties:
        idMappingType:
          type: string
          enum:
          - PROVIDER
          - RULE_BASED
          description: The type of ID mapping.
      required:
      - idMappingType
    NamespaceProviderProperties:
      type: object
      properties:
        providerServiceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the provider service.
        providerConfiguration:
          type: object
          description: An object which defines any additional configurations required by the provider service.
      required:
      - providerServiceArn
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    DeleteIdNamespaceInput:
      type: object
      properties:
        idNamespaceName:
          type: string
          description: The name of the ID namespace.
      required:
      - idNamespaceName
    IdNamespaceInputSource:
      type: object
      properties:
        inputSourceARN:
          type: string
          description: An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
        schemaName:
          type: string
          description: The name of the schema.
      required:
      - inputSourceARN
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    IdNamespaceSummary:
      type: object
      properties:
        idNamespaceName:
          type: string
          description: The name of the ID namespace.
        idNamespaceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ID namespace.
        description:
          type: string
          description: The description of the ID namespace.
        idMappingWorkflowProperties:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceIdMappingWorkflowMetadata'
          description: An object which defines any additional configurations required by the ID mapping workflow.
        type:
          type: string
          enum:
          - SOURCE
          - TARGET
          description: 'The type of ID namespace. There are two types: SOURCE and TARGET. The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow. The TARGET contains a configuration of targetId which all sourceIds will resolve to.'
        createdAt:
          type: string
          description: The timestamp of when the ID namespace was created.
        updatedAt:
          type: string
          description: The timestamp of when the ID namespace was last updated.
      required:
      - idNamespaceName
      - idNamespaceArn
      - type
      - createdAt
      - updatedAt
    GetIdNamespaceOutput:
      type: object
      properties:
        idNamespaceName:
          type: string
          description: The name of the ID namespace.
        idNamespaceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ID namespace.
        description:
          type: string
          description: The description of the ID namespace.
        inputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceInputSource'
          description: A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
        idMappingWorkflowProperties:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceIdMappingWorkflowProperties'
          description: Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
        type:
          type: string
          enum:
          - SOURCE
          - TARGET
          description: 'The type of ID namespace. There are two types: SOURCE and TARGET. The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow. The TARGET contains a configuration of targetId to which all sourceIds will resolve to.'
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.
        createdAt:
          type: string
          description: The timestamp of when the ID namespace was created.
        updatedAt:
          type: string
          description: The timestamp of when the ID namespace was last updated.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - idNamespaceName
      - idNamespaceArn
      - type
      - createdAt
      - updatedAt
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
    ConflictException:
      type: object
      properties:
        message:
          type: string
    IdNamespaceIdMappingWorkflowProperties:
      type: object
      properties:
        idMappingType:
          type: string
          enum:
          - PROVIDER
          - RULE_BASED
          description: The type of ID mapping.
        ruleBasedProperties:
          $ref: '#/components/schemas/NamespaceRuleBasedProperties'
        providerProperties:
          $ref: '#/components/schemas/NamespaceProviderProperties'
      required:
      - idMappingType
    GetIdNamespaceInput:
      type: object
      properties:
        idNamespaceName:
          type: string
          description: The name of the ID namespace.
      required:
      - idNamespaceName
    DeleteIdNamespaceOutput:
      type: object
      properties:
        message:
          type: string
          description: A successful operation message.
      required:
      - message
    CreateIdNamespaceOutput:
      type: object
      properties:
        idNamespaceName:
          type: string
          description: The name of the ID namespace.
        idNamespaceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the ID namespace.
        description:
          type: string
          description: The description of the ID namespace.
        inputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceInputSource'
          description: A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
        idMappingWorkflowProperties:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceIdMappingWorkflowProperties'
          description: Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
        type:
          type: string
          enum:
          - SOURCE
          - TARGET
          description: 'The type of ID namespace. There are two types: SOURCE and TARGET. The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow. The TARGET contains a configuration of targetId to which all sourceIds will resolve to.'
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in inputSourceConfig on your behalf as part of the workflow run.
        createdAt:
          type: string
          description: The timestamp of when the ID namespace was created.
        updatedAt:
          type: string
          description: The timestamp of when the ID namespace was last updated.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - idNamespaceName
      - idNamespaceArn
      - type
      - createdAt
      - updatedAt
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    Rule:
      type: object
      properties:
        ruleName:
          type: string
          description: A name for the matching rule.
        matchingKeys:
          type: array
          items:
            type: string
          description: 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.
      required:
      - ruleName
      - matchingKeys
    UpdateIdNamespaceInput:
      type: object
      properties:
        idNamespaceName:
          type: string
          description: The name of the ID namespace.
        description:
          type: string
          description: The description of the ID namespace.
        inputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceInputSource'
          description: A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
        idMappingWorkflowProperties:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceIdMappingWorkflowProperties'
          description: Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.
      required:
      - idNamespaceName
    CreateIdNamespaceInput:
      type: object
      properties:
        idNamespaceName:
          type: string
          description: The name of the ID namespace.
        description:
          type: string
          description: The description of the ID namespace.
        inputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceInputSource'
          description: A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
        idMappingWorkflowProperties:
          type: array
          items:
            $ref: '#/components/schemas/IdNamespaceIdMappingWorkflowProperties'
          description: Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target.
        type:
          type: string
          enum:
          - SOURCE
          - TARGET
          description: 'The type of ID namespace. There are two types: SOURCE and TARGET. The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow. The TARGET contains a configuration of targetId to which all sourceIds will resolve to.'
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - idNamespaceName
      - type
    ListIdNamespacesInput:
      type: object
      properties:
        nextToken:
          type: string
          description: The pagination token from the previous API call.
        maxResults:
          type: integer
          description: The maximum number of IdNamespace objects returned per page.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: entityresolution
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/entityresolution/service/2018-05-10/entityresolution-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)