Skip to content

Type definitions#

Index > EntityResolution > Type definitions

Auto-generated documentation for EntityResolution type annotations stubs module mypy-boto3-entityresolution.

IdMappingWorkflowInputSourceTypeDef#

# IdMappingWorkflowInputSourceTypeDef definition

class IdMappingWorkflowInputSourceTypeDef(TypedDict):
    inputSourceARN: str,
    schemaName: str,

IdMappingWorkflowOutputSourceTypeDef#

# IdMappingWorkflowOutputSourceTypeDef definition

class IdMappingWorkflowOutputSourceTypeDef(TypedDict):
    outputS3Path: str,
    KMSArn: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

IncrementalRunConfigTypeDef#

# IncrementalRunConfigTypeDef definition

class IncrementalRunConfigTypeDef(TypedDict):
    incrementalRunType: NotRequired[IncrementalRunTypeType],  # (1)
  1. See IncrementalRunTypeType

InputSourceTypeDef#

# InputSourceTypeDef definition

class InputSourceTypeDef(TypedDict):
    inputSourceARN: str,
    schemaName: str,
    applyNormalization: NotRequired[bool],

SchemaInputAttributeTypeDef#

# SchemaInputAttributeTypeDef definition

class SchemaInputAttributeTypeDef(TypedDict):
    fieldName: str,
    type: SchemaAttributeTypeType,  # (1)
    groupName: NotRequired[str],
    matchKey: NotRequired[str],
    subType: NotRequired[str],
  1. See SchemaAttributeTypeType

DeleteIdMappingWorkflowInputRequestTypeDef#

# DeleteIdMappingWorkflowInputRequestTypeDef definition

class DeleteIdMappingWorkflowInputRequestTypeDef(TypedDict):
    workflowName: str,

DeleteMatchingWorkflowInputRequestTypeDef#

# DeleteMatchingWorkflowInputRequestTypeDef definition

class DeleteMatchingWorkflowInputRequestTypeDef(TypedDict):
    workflowName: str,

DeleteSchemaMappingInputRequestTypeDef#

# DeleteSchemaMappingInputRequestTypeDef definition

class DeleteSchemaMappingInputRequestTypeDef(TypedDict):
    schemaName: str,

ErrorDetailsTypeDef#

# ErrorDetailsTypeDef definition

class ErrorDetailsTypeDef(TypedDict):
    errorMessage: NotRequired[str],

GetIdMappingJobInputRequestTypeDef#

# GetIdMappingJobInputRequestTypeDef definition

class GetIdMappingJobInputRequestTypeDef(TypedDict):
    jobId: str,
    workflowName: str,

IdMappingJobMetricsTypeDef#

# IdMappingJobMetricsTypeDef definition

class IdMappingJobMetricsTypeDef(TypedDict):
    inputRecords: NotRequired[int],
    recordsNotProcessed: NotRequired[int],
    totalRecordsProcessed: NotRequired[int],

GetIdMappingWorkflowInputRequestTypeDef#

# GetIdMappingWorkflowInputRequestTypeDef definition

class GetIdMappingWorkflowInputRequestTypeDef(TypedDict):
    workflowName: str,

GetMatchIdInputRequestTypeDef#

# GetMatchIdInputRequestTypeDef definition

class GetMatchIdInputRequestTypeDef(TypedDict):
    record: Mapping[str, str],
    workflowName: str,

GetMatchingJobInputRequestTypeDef#

# GetMatchingJobInputRequestTypeDef definition

class GetMatchingJobInputRequestTypeDef(TypedDict):
    jobId: str,
    workflowName: str,

JobMetricsTypeDef#

# JobMetricsTypeDef definition

class JobMetricsTypeDef(TypedDict):
    inputRecords: NotRequired[int],
    matchIDs: NotRequired[int],
    recordsNotProcessed: NotRequired[int],
    totalRecordsProcessed: NotRequired[int],

GetMatchingWorkflowInputRequestTypeDef#

# GetMatchingWorkflowInputRequestTypeDef definition

class GetMatchingWorkflowInputRequestTypeDef(TypedDict):
    workflowName: str,

GetProviderServiceInputRequestTypeDef#

# GetProviderServiceInputRequestTypeDef definition

class GetProviderServiceInputRequestTypeDef(TypedDict):
    providerName: str,
    providerServiceName: str,

ProviderIntermediateDataAccessConfigurationTypeDef#

# ProviderIntermediateDataAccessConfigurationTypeDef definition

class ProviderIntermediateDataAccessConfigurationTypeDef(TypedDict):
    awsAccountIds: NotRequired[List[str]],
    requiredBucketActions: NotRequired[List[str]],

GetSchemaMappingInputRequestTypeDef#

# GetSchemaMappingInputRequestTypeDef definition

class GetSchemaMappingInputRequestTypeDef(TypedDict):
    schemaName: str,

IdMappingWorkflowSummaryTypeDef#

# IdMappingWorkflowSummaryTypeDef definition

class IdMappingWorkflowSummaryTypeDef(TypedDict):
    createdAt: datetime,
    updatedAt: datetime,
    workflowArn: str,
    workflowName: str,

IntermediateSourceConfigurationTypeDef#

# IntermediateSourceConfigurationTypeDef definition

class IntermediateSourceConfigurationTypeDef(TypedDict):
    intermediateS3Path: str,

JobSummaryTypeDef#

# JobSummaryTypeDef definition

class JobSummaryTypeDef(TypedDict):
    jobId: str,
    startTime: datetime,
    status: JobStatusType,  # (1)
    endTime: NotRequired[datetime],
  1. See JobStatusType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListIdMappingJobsInputRequestTypeDef#

# ListIdMappingJobsInputRequestTypeDef definition

class ListIdMappingJobsInputRequestTypeDef(TypedDict):
    workflowName: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListIdMappingWorkflowsInputRequestTypeDef#

# ListIdMappingWorkflowsInputRequestTypeDef definition

class ListIdMappingWorkflowsInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListMatchingJobsInputRequestTypeDef#

# ListMatchingJobsInputRequestTypeDef definition

class ListMatchingJobsInputRequestTypeDef(TypedDict):
    workflowName: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListMatchingWorkflowsInputRequestTypeDef#

# ListMatchingWorkflowsInputRequestTypeDef definition

class ListMatchingWorkflowsInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

MatchingWorkflowSummaryTypeDef#

# MatchingWorkflowSummaryTypeDef definition

class MatchingWorkflowSummaryTypeDef(TypedDict):
    createdAt: datetime,
    resolutionType: ResolutionTypeType,  # (1)
    updatedAt: datetime,
    workflowArn: str,
    workflowName: str,
  1. See ResolutionTypeType

ListProviderServicesInputRequestTypeDef#

# ListProviderServicesInputRequestTypeDef definition

class ListProviderServicesInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    providerName: NotRequired[str],

ProviderServiceSummaryTypeDef#

# ProviderServiceSummaryTypeDef definition

class ProviderServiceSummaryTypeDef(TypedDict):
    providerName: str,
    providerServiceArn: str,
    providerServiceDisplayName: str,
    providerServiceName: str,
    providerServiceType: ServiceTypeType,  # (1)
  1. See ServiceTypeType

ListSchemaMappingsInputRequestTypeDef#

# ListSchemaMappingsInputRequestTypeDef definition

class ListSchemaMappingsInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

SchemaMappingSummaryTypeDef#

# SchemaMappingSummaryTypeDef definition

class SchemaMappingSummaryTypeDef(TypedDict):
    createdAt: datetime,
    hasWorkflows: bool,
    schemaArn: str,
    schemaName: str,
    updatedAt: datetime,

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,

OutputAttributeTypeDef#

# OutputAttributeTypeDef definition

class OutputAttributeTypeDef(TypedDict):
    name: str,
    hashed: NotRequired[bool],

ProviderMarketplaceConfigurationTypeDef#

# ProviderMarketplaceConfigurationTypeDef definition

class ProviderMarketplaceConfigurationTypeDef(TypedDict):
    assetId: str,
    dataSetId: str,
    listingId: str,
    revisionId: str,

RuleTypeDef#

# RuleTypeDef definition

class RuleTypeDef(TypedDict):
    matchingKeys: Sequence[str],
    ruleName: str,

StartIdMappingJobInputRequestTypeDef#

# StartIdMappingJobInputRequestTypeDef definition

class StartIdMappingJobInputRequestTypeDef(TypedDict):
    workflowName: str,

StartMatchingJobInputRequestTypeDef#

# StartMatchingJobInputRequestTypeDef definition

class StartMatchingJobInputRequestTypeDef(TypedDict):
    workflowName: str,

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

DeleteIdMappingWorkflowOutputTypeDef#

# DeleteIdMappingWorkflowOutputTypeDef definition

class DeleteIdMappingWorkflowOutputTypeDef(TypedDict):
    message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteMatchingWorkflowOutputTypeDef#

# DeleteMatchingWorkflowOutputTypeDef definition

class DeleteMatchingWorkflowOutputTypeDef(TypedDict):
    message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteSchemaMappingOutputTypeDef#

# DeleteSchemaMappingOutputTypeDef definition

class DeleteSchemaMappingOutputTypeDef(TypedDict):
    message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetMatchIdOutputTypeDef#

# GetMatchIdOutputTypeDef definition

class GetMatchIdOutputTypeDef(TypedDict):
    matchId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartIdMappingJobOutputTypeDef#

# StartIdMappingJobOutputTypeDef definition

class StartIdMappingJobOutputTypeDef(TypedDict):
    jobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartMatchingJobOutputTypeDef#

# StartMatchingJobOutputTypeDef definition

class StartMatchingJobOutputTypeDef(TypedDict):
    jobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSchemaMappingInputRequestTypeDef#

# CreateSchemaMappingInputRequestTypeDef definition

class CreateSchemaMappingInputRequestTypeDef(TypedDict):
    mappedInputFields: Sequence[SchemaInputAttributeTypeDef],  # (1)
    schemaName: str,
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See SchemaInputAttributeTypeDef

CreateSchemaMappingOutputTypeDef#

# CreateSchemaMappingOutputTypeDef definition

class CreateSchemaMappingOutputTypeDef(TypedDict):
    description: str,
    mappedInputFields: List[SchemaInputAttributeTypeDef],  # (1)
    schemaArn: str,
    schemaName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaInputAttributeTypeDef
  2. See ResponseMetadataTypeDef

GetSchemaMappingOutputTypeDef#

# GetSchemaMappingOutputTypeDef definition

class GetSchemaMappingOutputTypeDef(TypedDict):
    createdAt: datetime,
    description: str,
    hasWorkflows: bool,
    mappedInputFields: List[SchemaInputAttributeTypeDef],  # (1)
    schemaArn: str,
    schemaName: str,
    tags: Dict[str, str],
    updatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaInputAttributeTypeDef
  2. See ResponseMetadataTypeDef

UpdateSchemaMappingInputRequestTypeDef#

# UpdateSchemaMappingInputRequestTypeDef definition

class UpdateSchemaMappingInputRequestTypeDef(TypedDict):
    mappedInputFields: Sequence[SchemaInputAttributeTypeDef],  # (1)
    schemaName: str,
    description: NotRequired[str],
  1. See SchemaInputAttributeTypeDef

UpdateSchemaMappingOutputTypeDef#

# UpdateSchemaMappingOutputTypeDef definition

class UpdateSchemaMappingOutputTypeDef(TypedDict):
    description: str,
    mappedInputFields: List[SchemaInputAttributeTypeDef],  # (1)
    schemaArn: str,
    schemaName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaInputAttributeTypeDef
  2. See ResponseMetadataTypeDef

GetIdMappingJobOutputTypeDef#

# GetIdMappingJobOutputTypeDef definition

class GetIdMappingJobOutputTypeDef(TypedDict):
    endTime: datetime,
    errorDetails: ErrorDetailsTypeDef,  # (1)
    jobId: str,
    metrics: IdMappingJobMetricsTypeDef,  # (2)
    startTime: datetime,
    status: JobStatusType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ErrorDetailsTypeDef
  2. See IdMappingJobMetricsTypeDef
  3. See JobStatusType
  4. See ResponseMetadataTypeDef

GetMatchingJobOutputTypeDef#

# GetMatchingJobOutputTypeDef definition

class GetMatchingJobOutputTypeDef(TypedDict):
    endTime: datetime,
    errorDetails: ErrorDetailsTypeDef,  # (1)
    jobId: str,
    metrics: JobMetricsTypeDef,  # (2)
    startTime: datetime,
    status: JobStatusType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ErrorDetailsTypeDef
  2. See JobMetricsTypeDef
  3. See JobStatusType
  4. See ResponseMetadataTypeDef

ListIdMappingWorkflowsOutputTypeDef#

# ListIdMappingWorkflowsOutputTypeDef definition

class ListIdMappingWorkflowsOutputTypeDef(TypedDict):
    nextToken: str,
    workflowSummaries: List[IdMappingWorkflowSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdMappingWorkflowSummaryTypeDef
  2. See ResponseMetadataTypeDef

ProviderPropertiesTypeDef#

# ProviderPropertiesTypeDef definition

class ProviderPropertiesTypeDef(TypedDict):
    providerServiceArn: str,
    intermediateSourceConfiguration: NotRequired[IntermediateSourceConfigurationTypeDef],  # (1)
    providerConfiguration: NotRequired[Mapping[str, Any]],
  1. See IntermediateSourceConfigurationTypeDef

ListIdMappingJobsOutputTypeDef#

# ListIdMappingJobsOutputTypeDef definition

class ListIdMappingJobsOutputTypeDef(TypedDict):
    jobs: List[JobSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListMatchingJobsOutputTypeDef#

# ListMatchingJobsOutputTypeDef definition

class ListMatchingJobsOutputTypeDef(TypedDict):
    jobs: List[JobSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListIdMappingJobsInputListIdMappingJobsPaginateTypeDef#

# ListIdMappingJobsInputListIdMappingJobsPaginateTypeDef definition

class ListIdMappingJobsInputListIdMappingJobsPaginateTypeDef(TypedDict):
    workflowName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListIdMappingWorkflowsInputListIdMappingWorkflowsPaginateTypeDef#

# ListIdMappingWorkflowsInputListIdMappingWorkflowsPaginateTypeDef definition

class ListIdMappingWorkflowsInputListIdMappingWorkflowsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMatchingJobsInputListMatchingJobsPaginateTypeDef#

# ListMatchingJobsInputListMatchingJobsPaginateTypeDef definition

class ListMatchingJobsInputListMatchingJobsPaginateTypeDef(TypedDict):
    workflowName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMatchingWorkflowsInputListMatchingWorkflowsPaginateTypeDef#

# ListMatchingWorkflowsInputListMatchingWorkflowsPaginateTypeDef definition

class ListMatchingWorkflowsInputListMatchingWorkflowsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProviderServicesInputListProviderServicesPaginateTypeDef#

# ListProviderServicesInputListProviderServicesPaginateTypeDef definition

class ListProviderServicesInputListProviderServicesPaginateTypeDef(TypedDict):
    providerName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSchemaMappingsInputListSchemaMappingsPaginateTypeDef#

# ListSchemaMappingsInputListSchemaMappingsPaginateTypeDef definition

class ListSchemaMappingsInputListSchemaMappingsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMatchingWorkflowsOutputTypeDef#

# ListMatchingWorkflowsOutputTypeDef definition

class ListMatchingWorkflowsOutputTypeDef(TypedDict):
    nextToken: str,
    workflowSummaries: List[MatchingWorkflowSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MatchingWorkflowSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListProviderServicesOutputTypeDef#

# ListProviderServicesOutputTypeDef definition

class ListProviderServicesOutputTypeDef(TypedDict):
    nextToken: str,
    providerServiceSummaries: List[ProviderServiceSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProviderServiceSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSchemaMappingsOutputTypeDef#

# ListSchemaMappingsOutputTypeDef definition

class ListSchemaMappingsOutputTypeDef(TypedDict):
    nextToken: str,
    schemaList: List[SchemaMappingSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaMappingSummaryTypeDef
  2. See ResponseMetadataTypeDef

OutputSourceTypeDef#

# OutputSourceTypeDef definition

class OutputSourceTypeDef(TypedDict):
    output: Sequence[OutputAttributeTypeDef],  # (1)
    outputS3Path: str,
    KMSArn: NotRequired[str],
    applyNormalization: NotRequired[bool],
  1. See OutputAttributeTypeDef

ProviderEndpointConfigurationTypeDef#

# ProviderEndpointConfigurationTypeDef definition

class ProviderEndpointConfigurationTypeDef(TypedDict):
    marketplaceConfiguration: NotRequired[ProviderMarketplaceConfigurationTypeDef],  # (1)
  1. See ProviderMarketplaceConfigurationTypeDef

RuleBasedPropertiesTypeDef#

# RuleBasedPropertiesTypeDef definition

class RuleBasedPropertiesTypeDef(TypedDict):
    attributeMatchingModel: AttributeMatchingModelType,  # (1)
    rules: Sequence[RuleTypeDef],  # (2)
  1. See AttributeMatchingModelType
  2. See RuleTypeDef

IdMappingTechniquesTypeDef#

# IdMappingTechniquesTypeDef definition

class IdMappingTechniquesTypeDef(TypedDict):
    idMappingType: IdMappingTypeType,  # (1)
    providerProperties: ProviderPropertiesTypeDef,  # (2)
  1. See IdMappingTypeType
  2. See ProviderPropertiesTypeDef

GetProviderServiceOutputTypeDef#

# GetProviderServiceOutputTypeDef definition

class GetProviderServiceOutputTypeDef(TypedDict):
    anonymizedOutput: bool,
    providerConfigurationDefinition: Dict[str, Any],
    providerEndpointConfiguration: ProviderEndpointConfigurationTypeDef,  # (1)
    providerEntityOutputDefinition: Dict[str, Any],
    providerIntermediateDataAccessConfiguration: ProviderIntermediateDataAccessConfigurationTypeDef,  # (2)
    providerName: str,
    providerServiceArn: str,
    providerServiceDisplayName: str,
    providerServiceName: str,
    providerServiceType: ServiceTypeType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ProviderEndpointConfigurationTypeDef
  2. See ProviderIntermediateDataAccessConfigurationTypeDef
  3. See ServiceTypeType
  4. See ResponseMetadataTypeDef

ResolutionTechniquesTypeDef#

# ResolutionTechniquesTypeDef definition

class ResolutionTechniquesTypeDef(TypedDict):
    resolutionType: ResolutionTypeType,  # (2)
    providerProperties: NotRequired[ProviderPropertiesTypeDef],  # (1)
    ruleBasedProperties: NotRequired[RuleBasedPropertiesTypeDef],  # (3)
  1. See ProviderPropertiesTypeDef
  2. See ResolutionTypeType
  3. See RuleBasedPropertiesTypeDef

CreateIdMappingWorkflowInputRequestTypeDef#

# CreateIdMappingWorkflowInputRequestTypeDef definition

class CreateIdMappingWorkflowInputRequestTypeDef(TypedDict):
    idMappingTechniques: IdMappingTechniquesTypeDef,  # (1)
    inputSourceConfig: Sequence[IdMappingWorkflowInputSourceTypeDef],  # (2)
    outputSourceConfig: Sequence[IdMappingWorkflowOutputSourceTypeDef],  # (3)
    roleArn: str,
    workflowName: str,
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See I