Skip to content

Type definitions#

Index > CustomerProfiles > Type definitions

Auto-generated documentation for CustomerProfiles type annotations stubs module mypy-boto3-customer-profiles.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AddProfileKeyRequestRequestTypeDef#

# AddProfileKeyRequestRequestTypeDef definition

class AddProfileKeyRequestRequestTypeDef(TypedDict):
    ProfileId: str,
    KeyName: str,
    Values: Sequence[str],
    DomainName: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

AdditionalSearchKeyTypeDef#

# AdditionalSearchKeyTypeDef definition

class AdditionalSearchKeyTypeDef(TypedDict):
    KeyName: str,
    Values: Sequence[str],

AddressTypeDef#

# AddressTypeDef definition

class AddressTypeDef(TypedDict):
    Address1: NotRequired[str],
    Address2: NotRequired[str],
    Address3: NotRequired[str],
    Address4: NotRequired[str],
    City: NotRequired[str],
    County: NotRequired[str],
    State: NotRequired[str],
    Province: NotRequired[str],
    Country: NotRequired[str],
    PostalCode: NotRequired[str],

AppflowIntegrationWorkflowAttributesTypeDef#

# AppflowIntegrationWorkflowAttributesTypeDef definition

class AppflowIntegrationWorkflowAttributesTypeDef(TypedDict):
    SourceConnectorType: SourceConnectorTypeType,  # (1)
    ConnectorProfileName: str,
    RoleArn: NotRequired[str],
  1. See SourceConnectorTypeType

AppflowIntegrationWorkflowMetricsTypeDef#

# AppflowIntegrationWorkflowMetricsTypeDef definition

class AppflowIntegrationWorkflowMetricsTypeDef(TypedDict):
    RecordsProcessed: int,
    StepsCompleted: int,
    TotalSteps: int,

AppflowIntegrationWorkflowStepTypeDef#

# AppflowIntegrationWorkflowStepTypeDef definition

class AppflowIntegrationWorkflowStepTypeDef(TypedDict):
    FlowName: str,
    Status: StatusType,  # (1)
    ExecutionMessage: str,
    RecordsProcessed: int,
    BatchRecordsStartTime: str,
    BatchRecordsEndTime: str,
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
  1. See StatusType

AttributeItemTypeDef#

# AttributeItemTypeDef definition

class AttributeItemTypeDef(TypedDict):
    Name: str,

AttributeTypesSelectorTypeDef#

# AttributeTypesSelectorTypeDef definition

class AttributeTypesSelectorTypeDef(TypedDict):
    AttributeMatchingModel: AttributeMatchingModelType,  # (1)
    Address: NotRequired[Sequence[str]],
    PhoneNumber: NotRequired[Sequence[str]],
    EmailAddress: NotRequired[Sequence[str]],
  1. See AttributeMatchingModelType

ConflictResolutionTypeDef#

# ConflictResolutionTypeDef definition

class ConflictResolutionTypeDef(TypedDict):
    ConflictResolvingModel: ConflictResolvingModelType,  # (1)
    SourceName: NotRequired[str],
  1. See ConflictResolvingModelType

ConsolidationTypeDef#

# ConsolidationTypeDef definition

class ConsolidationTypeDef(TypedDict):
    MatchingAttributesList: Sequence[Sequence[str]],

RangeTypeDef#

# RangeTypeDef definition

class RangeTypeDef(TypedDict):
    Value: int,
    Unit: UnitType,  # (1)
  1. See UnitType

ThresholdTypeDef#

# ThresholdTypeDef definition

class ThresholdTypeDef(TypedDict):
    Value: str,
    Operator: OperatorType,  # (1)
  1. See OperatorType

ConnectorOperatorTypeDef#

# ConnectorOperatorTypeDef definition

class ConnectorOperatorTypeDef(TypedDict):
    Marketo: NotRequired[MarketoConnectorOperatorType],  # (1)
    S3: NotRequired[S3ConnectorOperatorType],  # (2)
    Salesforce: NotRequired[SalesforceConnectorOperatorType],  # (3)
    ServiceNow: NotRequired[ServiceNowConnectorOperatorType],  # (4)
    Zendesk: NotRequired[ZendeskConnectorOperatorType],  # (5)
  1. See MarketoConnectorOperatorType
  2. See S3ConnectorOperatorType
  3. See SalesforceConnectorOperatorType
  4. See ServiceNowConnectorOperatorType
  5. See ZendeskConnectorOperatorType

CreateEventStreamRequestRequestTypeDef#

# CreateEventStreamRequestRequestTypeDef definition

class CreateEventStreamRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Uri: str,
    EventStreamName: str,
    Tags: NotRequired[Mapping[str, str]],

DeleteCalculatedAttributeDefinitionRequestRequestTypeDef#

# DeleteCalculatedAttributeDefinitionRequestRequestTypeDef definition

class DeleteCalculatedAttributeDefinitionRequestRequestTypeDef(TypedDict):
    DomainName: str,
    CalculatedAttributeName: str,

DeleteDomainRequestRequestTypeDef#

# DeleteDomainRequestRequestTypeDef definition

class DeleteDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

DeleteEventStreamRequestRequestTypeDef#

# DeleteEventStreamRequestRequestTypeDef definition

class DeleteEventStreamRequestRequestTypeDef(TypedDict):
    DomainName: str,
    EventStreamName: str,

DeleteIntegrationRequestRequestTypeDef#

# DeleteIntegrationRequestRequestTypeDef definition

class DeleteIntegrationRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Uri: str,

DeleteProfileKeyRequestRequestTypeDef#

# DeleteProfileKeyRequestRequestTypeDef definition

class DeleteProfileKeyRequestRequestTypeDef(TypedDict):
    ProfileId: str,
    KeyName: str,
    Values: Sequence[str],
    DomainName: str,

DeleteProfileObjectRequestRequestTypeDef#

# DeleteProfileObjectRequestRequestTypeDef definition

class DeleteProfileObjectRequestRequestTypeDef(TypedDict):
    ProfileId: str,
    ProfileObjectUniqueKey: str,
    ObjectTypeName: str,
    DomainName: str,

DeleteProfileObjectTypeRequestRequestTypeDef#

# DeleteProfileObjectTypeRequestRequestTypeDef definition

class DeleteProfileObjectTypeRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ObjectTypeName: str,

DeleteProfileRequestRequestTypeDef#

# DeleteProfileRequestRequestTypeDef definition

class DeleteProfileRequestRequestTypeDef(TypedDict):
    ProfileId: str,
    DomainName: str,

DeleteWorkflowRequestRequestTypeDef#

# DeleteWorkflowRequestRequestTypeDef definition

class DeleteWorkflowRequestRequestTypeDef(TypedDict):
    DomainName: str,
    WorkflowId: str,

DestinationSummaryTypeDef#

# DestinationSummaryTypeDef definition

class DestinationSummaryTypeDef(TypedDict):
    Uri: str,
    Status: EventStreamDestinationStatusType,  # (1)
    UnhealthySince: NotRequired[datetime],
  1. See EventStreamDestinationStatusType

DetectProfileObjectTypeRequestRequestTypeDef#

# DetectProfileObjectTypeRequestRequestTypeDef definition

class DetectProfileObjectTypeRequestRequestTypeDef(TypedDict):
    Objects: Sequence[str],
    DomainName: str,

ObjectTypeFieldTypeDef#

# ObjectTypeFieldTypeDef definition

class ObjectTypeFieldTypeDef(TypedDict):
    Source: NotRequired[str],
    Target: NotRequired[str],
    ContentType: NotRequired[FieldContentTypeType],  # (1)
  1. See FieldContentTypeType

ObjectTypeKeyTypeDef#

# ObjectTypeKeyTypeDef definition

class ObjectTypeKeyTypeDef(TypedDict):
    StandardIdentifiers: NotRequired[List[StandardIdentifierType]],  # (1)
    FieldNames: NotRequired[List[str]],
  1. See StandardIdentifierType

DomainStatsTypeDef#

# DomainStatsTypeDef definition

class DomainStatsTypeDef(TypedDict):
    ProfileCount: NotRequired[int],
    MeteringProfileCount: NotRequired[int],
    ObjectCount: NotRequired[int],
    TotalSize: NotRequired[int],

EventStreamDestinationDetailsTypeDef#

# EventStreamDestinationDetailsTypeDef definition

class EventStreamDestinationDetailsTypeDef(TypedDict):
    Uri: str,
    Status: EventStreamDestinationStatusType,  # (1)
    UnhealthySince: NotRequired[datetime],
    Message: NotRequired[str],
  1. See EventStreamDestinationStatusType

S3ExportingConfigTypeDef#

# S3ExportingConfigTypeDef definition

class S3ExportingConfigTypeDef(TypedDict):
    S3BucketName: str,
    S3KeyName: NotRequired[str],

S3ExportingLocationTypeDef#

# S3ExportingLocationTypeDef definition

class S3ExportingLocationTypeDef(TypedDict):
    S3BucketName: NotRequired[str],
    S3KeyName: NotRequired[str],

FieldSourceProfileIdsTypeDef#

# FieldSourceProfileIdsTypeDef definition

class FieldSourceProfileIdsTypeDef(TypedDict):
    AccountNumber: NotRequired[str],
    AdditionalInformation: NotRequired[str],
    PartyType: NotRequired[str],
    BusinessName: NotRequired[str],
    FirstName: NotRequired[str],
    MiddleName: NotRequired[str],
    LastName: NotRequired[str],
    BirthDate: NotRequired[str],
    Gender: NotRequired[str],
    PhoneNumber: NotRequired[str],
    MobilePhoneNumber: NotRequired[str],
    HomePhoneNumber: NotRequired[str],
    BusinessPhoneNumber: NotRequired[str],
    EmailAddress: NotRequired[str],
    PersonalEmailAddress: NotRequired[str],
    BusinessEmailAddress: NotRequired[str],
    Address: NotRequired[str],
    ShippingAddress: NotRequired[str],
    MailingAddress: NotRequired[str],
    BillingAddress: NotRequired[str],
    Attributes: NotRequired[Mapping[str, str]],

FoundByKeyValueTypeDef#

# FoundByKeyValueTypeDef definition

class FoundByKeyValueTypeDef(TypedDict):
    KeyName: NotRequired[str],
    Values: NotRequired[List[str]],

GetCalculatedAttributeDefinitionRequestRequestTypeDef#

# GetCalculatedAttributeDefinitionRequestRequestTypeDef definition

class GetCalculatedAttributeDefinitionRequestRequestTypeDef(TypedDict):
    DomainName: str,
    CalculatedAttributeName: str,

GetCalculatedAttributeForProfileRequestRequestTypeDef#

# GetCalculatedAttributeForProfileRequestRequestTypeDef definition

class GetCalculatedAttributeForProfileRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ProfileId: str,
    CalculatedAttributeName: str,

GetDomainRequestRequestTypeDef#

# GetDomainRequestRequestTypeDef definition

class GetDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,

GetEventStreamRequestRequestTypeDef#

# GetEventStreamRequestRequestTypeDef definition

class GetEventStreamRequestRequestTypeDef(TypedDict):
    DomainName: str,
    EventStreamName: str,

GetIdentityResolutionJobRequestRequestTypeDef#

# GetIdentityResolutionJobRequestRequestTypeDef definition

class GetIdentityResolutionJobRequestRequestTypeDef(TypedDict):
    DomainName: str,
    JobId: str,

JobStatsTypeDef#

# JobStatsTypeDef definition

class JobStatsTypeDef(TypedDict):
    NumberOfProfilesReviewed: NotRequired[int],
    NumberOfMatchesFound: NotRequired[int],
    NumberOfMergesDone: NotRequired[int],

GetIntegrationRequestRequestTypeDef#

# GetIntegrationRequestRequestTypeDef definition

class GetIntegrationRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Uri: str,

GetMatchesRequestRequestTypeDef#

# GetMatchesRequestRequestTypeDef definition

class GetMatchesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

MatchItemTypeDef#

# MatchItemTypeDef definition

class MatchItemTypeDef(TypedDict):
    MatchId: NotRequired[str],
    ProfileIds: NotRequired[List[str]],
    ConfidenceScore: NotRequired[float],

GetProfileObjectTypeRequestRequestTypeDef#

# GetProfileObjectTypeRequestRequestTypeDef definition

class GetProfileObjectTypeRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ObjectTypeName: str,

GetProfileObjectTypeTemplateRequestRequestTypeDef#

# GetProfileObjectTypeTemplateRequestRequestTypeDef definition

class GetProfileObjectTypeTemplateRequestRequestTypeDef(TypedDict):
    TemplateId: str,

GetSimilarProfilesRequestRequestTypeDef#

# GetSimilarProfilesRequestRequestTypeDef definition

class GetSimilarProfilesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MatchType: MatchTypeType,  # (1)
    SearchKey: str,
    SearchValue: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See MatchTypeType

GetWorkflowRequestRequestTypeDef#

# GetWorkflowRequestRequestTypeDef definition

class GetWorkflowRequestRequestTypeDef(TypedDict):
    DomainName: str,
    WorkflowId: str,

GetWorkflowStepsRequestRequestTypeDef#

# GetWorkflowStepsRequestRequestTypeDef definition

class GetWorkflowStepsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    WorkflowId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

IncrementalPullConfigTypeDef#

# IncrementalPullConfigTypeDef definition

class IncrementalPullConfigTypeDef(TypedDict):
    DatetimeTypeFieldName: NotRequired[str],

JobScheduleTypeDef#

# JobScheduleTypeDef definition

class JobScheduleTypeDef(TypedDict):
    DayOfTheWeek: JobScheduleDayOfTheWeekType,  # (1)
    Time: str,
  1. See JobScheduleDayOfTheWeekType

ListAccountIntegrationsRequestRequestTypeDef#

# ListAccountIntegrationsRequestRequestTypeDef definition

class ListAccountIntegrationsRequestRequestTypeDef(TypedDict):
    Uri: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    IncludeHidden: NotRequired[bool],

ListIntegrationItemTypeDef#

# ListIntegrationItemTypeDef definition

class ListIntegrationItemTypeDef(TypedDict):
    DomainName: str,
    Uri: str,
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    ObjectTypeName: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],
    ObjectTypeNames: NotRequired[Dict[str, str]],
    WorkflowId: NotRequired[str],
    IsUnstructured: NotRequired[bool],

ListCalculatedAttributeDefinitionItemTypeDef#

# ListCalculatedAttributeDefinitionItemTypeDef definition

class ListCalculatedAttributeDefinitionItemTypeDef(TypedDict):
    CalculatedAttributeName: NotRequired[str],
    DisplayName: NotRequired[str],
    Description: NotRequired[str],
    CreatedAt: NotRequired[datetime],
    LastUpdatedAt: NotRequired[datetime],
    Tags: NotRequired[Dict[str, str]],

ListCalculatedAttributeDefinitionsRequestRequestTypeDef#

# ListCalculatedAttributeDefinitionsRequestRequestTypeDef definition

class ListCalculatedAttributeDefinitionsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListCalculatedAttributeForProfileItemTypeDef#

# ListCalculatedAttributeForProfileItemTypeDef definition

class ListCalculatedAttributeForProfileItemTypeDef(TypedDict):
    CalculatedAttributeName: NotRequired[str],
    DisplayName: NotRequired[str],
    IsDataPartial: NotRequired[str],
    Value: NotRequired[str],

ListCalculatedAttributesForProfileRequestRequestTypeDef#

# ListCalculatedAttributesForProfileRequestRequestTypeDef definition

class ListCalculatedAttributesForProfileRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ProfileId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListDomainItemTypeDef#

# ListDomainItemTypeDef definition

class ListDomainItemTypeDef(TypedDict):
    DomainName: str,
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    Tags: NotRequired[Dict[str, str]],

ListDomainsRequestRequestTypeDef#

# ListDomainsRequestRequestTypeDef definition

class ListDomainsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListEventStreamsRequestRequestTypeDef#

# ListEventStreamsRequestRequestTypeDef definition

class ListEventStreamsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListIdentityResolutionJobsRequestRequestTypeDef#

# ListIdentityResolutionJobsRequestRequestTypeDef definition

class ListIdentityResolutionJobsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListIntegrationsRequestRequestTypeDef#

# ListIntegrationsRequestRequestTypeDef definition

class ListIntegrationsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    IncludeHidden: NotRequired[bool],

ListProfileObjectTypeItemTypeDef#

# ListProfileObjectTypeItemTypeDef definition

class ListProfileObjectTypeItemTypeDef(TypedDict):
    ObjectTypeName: str,
    Description: str,
    CreatedAt: NotRequired[datetime],
    LastUpdatedAt: NotRequired[datetime],
    Tags: NotRequired[Dict[str, str]],

ListProfileObjectTypeTemplateItemTypeDef#

# ListProfileObjectTypeTemplateItemTypeDef definition

class ListProfileObjectTypeTemplateItemTypeDef(TypedDict):
    TemplateId: NotRequired[str],
    SourceName: NotRequired[str],
    SourceObject: NotRequired[str],

ListProfileObjectTypeTemplatesRequestRequestTypeDef#

# ListProfileObjectTypeTemplatesRequestRequestTypeDef definition

class ListProfileObjectTypeTemplatesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListProfileObjectTypesRequestRequestTypeDef#

# ListProfileObjectTypesRequestRequestTypeDef definition

class ListProfileObjectTypesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListProfileObjectsItemTypeDef#

# ListProfileObjectsItemTypeDef definition

class ListProfileObjectsItemTypeDef(TypedDict):
    ObjectTypeName: NotRequired[str],
    ProfileObjectUniqueKey: NotRequired[str],
    Object: NotRequired[str],

ObjectFilterTypeDef#

# ObjectFilterTypeDef definition

class ObjectFilterTypeDef(TypedDict):
    KeyName: str,
    Values: Sequence[str],

ListRuleBasedMatchesRequestRequestTypeDef#

# ListRuleBasedMatchesRequestRequestTypeDef definition

class ListRuleBasedMatchesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListWorkflowsItemTypeDef#

# ListWorkflowsItemTypeDef definition

class ListWorkflowsItemTypeDef(TypedDict):
    WorkflowType: WorkflowTypeType,  # (1)
    WorkflowId: str,
    Status: StatusType,  # (2)
    StatusDescription: str,
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
  1. See WorkflowTypeType
  2. See StatusType

MarketoSourcePropertiesTypeDef#

# MarketoSourcePropertiesTypeDef definition

class MarketoSourcePropertiesTypeDef(TypedDict):
    Object: str,

MatchingRuleTypeDef#

# MatchingRuleTypeDef definition

class MatchingRuleTypeDef(TypedDict):
    Rule: Sequence[str],

PutProfileObjectRequestRequestTypeDef#

# PutProfileObjectRequestRequestTypeDef definition

class PutProfileObjectRequestRequestTypeDef(TypedDict):
    ObjectTypeName: str,
    Object: str,
    DomainName: str,

S3SourcePropertiesTypeDef#

# S3SourcePropertiesTypeDef definition

class S3SourcePropertiesTypeDef(TypedDict):
    BucketName: str,
    BucketPrefix: NotRequired[str],

SalesforceSourcePropertiesTypeDef#

# SalesforceSourcePropertiesTypeDef definition

class SalesforceSourcePropertiesTypeDef(TypedDict):
    Object: str,
    EnableDynamicFieldUpdate: NotRequired[bool],
    IncludeDeletedRecords: NotRequired[bool],

ServiceNowSourcePropertiesTypeDef#

# ServiceNowSourcePropertiesTypeDef definition

class ServiceNowSourcePropertiesTypeDef(TypedDict):
    Object: str,

ZendeskSourcePropertiesTypeDef#

# ZendeskSourcePropertiesTypeDef definition

class ZendeskSourcePropertiesTypeDef(TypedDict):
    Object: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateAddressTypeDef#

# UpdateAddressTypeDef definition

class UpdateAddressTypeDef(TypedDict):
    Address1: NotRequired[str],
    Address2: NotRequired[str],
    Address3: NotRequired[str],
    Address4: NotRequired[str],
    City: NotRequired[str],
    County: NotRequired[str],
    State: NotRequired[str],
    Province: NotRequired[str],
    Country: NotRequired[str],
    PostalCode: NotRequired[str],

AddProfileKeyResponseTypeDef#

# AddProfileKeyResponseTypeDef definition

class AddProfileKeyResponseTypeDef(TypedDict):
    KeyName: str,
    Values: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateEventStreamResponseTypeDef#

# CreateEventStreamResponseTypeDef definition

class CreateEventStreamResponseTypeDef(TypedDict):
    EventStreamArn: str,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateIntegrationWorkflowResponseTypeDef#

# CreateIntegrationWorkflowResponseTypeDef definition

class CreateIntegrationWorkflowResponseTypeDef(TypedDict):
    WorkflowId: str,
    Message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateProfileResponseTypeDef#

# CreateProfileResponseTypeDef definition

class CreateProfileResponseTypeDef(TypedDict):
    ProfileId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteDomainResponseTypeDef#

# DeleteDomainResponseTypeDef definition

class DeleteDomainResponseTypeDef(TypedDict):
    Message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteIntegrationResponseTypeDef#

# DeleteIntegrationResponseTypeDef definition

class DeleteIntegrationResponseTypeDef(TypedDict):
    Message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteProfileKeyResponseTypeDef#

# DeleteProfileKeyResponseTypeDef definition

class DeleteProfileKeyResponseTypeDef(TypedDict):
    Message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteProfileObjectResponseTypeDef#

# DeleteProfileObjectResponseTypeDef definition

class DeleteProfileObjectResponseTypeDef(TypedDict):
    Message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteProfileObjectTypeResponseTypeDef#

# DeleteProfileObjectTypeResponseTypeDef definition

class DeleteProfileObjectTypeResponseTypeDef(TypedDict):
    Message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteProfileResponseTypeDef#

# DeleteProfileResponseTypeDef definition

class DeleteProfileResponseTypeDef(TypedDict):
    Message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAutoMergingPreviewResponseTypeDef#

# GetAutoMergingPreviewResponseTypeDef definition

class GetAutoMergingPreviewResponseTypeDef(TypedDict):
    DomainName: str,
    NumberOfMatchesInSample: int,
    NumberOfProfilesInSample: int,
    NumberOfProfilesWillBeMerged: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetCalculatedAttributeForProfileResponseTypeDef#

# GetCalculatedAttributeForProfileResponseTypeDef definition

class GetCalculatedAttributeForProfileResponseTypeDef(TypedDict):
    CalculatedAttributeName: str,
    DisplayName: str,
    IsDataPartial: str,
    Value: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetIntegrationResponseTypeDef#

# GetIntegrationResponseTypeDef definition

class GetIntegrationResponseTypeDef(TypedDict):
    DomainName: str,
    Uri: str,
    ObjectTypeName: str,
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    Tags: Dict[str, str],
    ObjectTypeNames: Dict[str, str],
    WorkflowId: str,
    IsUnstructured: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSimilarProfilesResponseTypeDef#

# GetSimilarProfilesResponseTypeDef definition

class GetSimilarProfilesResponseTypeDef(TypedDict):
    ProfileIds: List[str],
    MatchId: str,
    MatchType: MatchTypeType,  # (1)
    RuleLevel: int,
    ConfidenceScore: float,
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MatchTypeType
  2. See ResponseMetadataTypeDef

ListRuleBasedMatchesResponseTypeDef#

# ListRuleBasedMatchesResponseTypeDef definition

class ListRuleBasedMatchesResponseTypeDef(TypedDict):
    MatchIds: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

MergeProfilesResponseTypeDef#

# MergeProfilesResponseTypeDef definition

class MergeProfilesResponseTypeDef(TypedDict):
    Message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutIntegrationResponseTypeDef#

# PutIntegrationResponseTypeDef definition

class PutIntegrationResponseTypeDef(TypedDict):
    DomainName: str,
    Uri: str,
    ObjectTypeName: str,
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    Tags: Dict[str, str],
    ObjectTypeNames: Dict[str, str],
    WorkflowId: str,
    IsUnstructured: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutProfileObjectResponseTypeDef#

# PutProfileObjectResponseTypeDef definition

class PutProfileObjectResponseTypeDef(TypedDict):
    ProfileObjectUniqueKey: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateProfileResponseTypeDef#

# UpdateProfileResponseTypeDef definition

class UpdateProfileResponseTypeDef(TypedDict):
    ProfileId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SearchProfilesRequestRequestTypeDef#

# SearchProfilesRequestRequestTypeDef definition

class SearchProfilesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    KeyName: str,
    Values: Sequence[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    AdditionalSearchKeys: NotRequired[Sequence[AdditionalSearchKeyTypeDef]],  # (1)
    LogicalOperator: NotRequired[logicalOperatorType],  # (2)
  1. See AdditionalSearchKeyTypeDef
  2. See logicalOperatorType

CreateProfileRequestRequestTypeDef#

# CreateProfileRequestRequestTypeDef definition

class CreateProfileRequestRequestTypeDef(TypedDict):
    DomainName: str,
    AccountNumber: NotRequired[str],
    AdditionalInformation: NotRequired[str],
    PartyType: NotRequired[PartyTypeType],  # (1)
    BusinessName: NotRequired[str],
    FirstName: NotRequired[str],
    MiddleName: NotRequired[str],
    LastName: NotRequired[str],
    BirthDate: NotRequired[str],
    Gender: NotRequired[GenderType],  # (2)
    PhoneNumber: NotRequired[str],
    MobilePhoneNumber: NotRequired[str],
    HomePhoneNumber: NotRequired[str],
    BusinessPhoneNumber: NotRequired[str],
    EmailAddress: NotRequired[str],
    PersonalEmailAddress: NotRequired[str],
    BusinessEmailAddress: NotRequired[str],
    Address: NotRequired[AddressTypeDef],  # (3)
    ShippingAddress: NotRequired[AddressTypeDef],  # (3)
    MailingAddress: NotRequired[AddressTypeDef],  # (3)
    BillingAddress: NotRequired[AddressTypeDef],  # (3)
    Attributes: NotRequired[Mapping[str, str]],
    PartyTypeString: NotRequired[str],
    GenderString: NotRequired[str],
  1. See PartyTypeType
  2. See GenderType
  3. See AddressTypeDef
  4. See AddressTypeDef
  5. See AddressTypeDef
  6. See AddressTypeDef

WorkflowAttributesTypeDef#

# WorkflowAttributesTypeDef definition

class WorkflowAttributesTypeDef(TypedDict):
    AppflowIntegration: NotRequired[AppflowIntegrationWorkflowAttributesTypeDef],  # (1)
  1. See AppflowIntegrationWorkflowAttributesTypeDef

WorkflowMetricsTypeDef#

# WorkflowMetricsTypeDef definition

class WorkflowMetricsTypeDef(TypedDict):
    AppflowIntegration: NotRequired[AppflowIntegrationWorkflowMetricsTypeDef],  # (1)
  1. See AppflowIntegrationWorkflowMetricsTypeDef

WorkflowStepItemTypeDef#

# WorkflowStepItemTypeDef definition

class WorkflowStepItemTypeDef(TypedDict):
    AppflowIntegration: NotRequired[AppflowIntegrationWorkflowStepTypeDef],  # (1)
  1. See AppflowIntegrationWorkflowStepTypeDef

AttributeDetailsTypeDef#

# AttributeDetailsTypeDef definition

class AttributeDetailsTypeDef(TypedDict):
    Attributes: Sequence[AttributeItemTypeDef],  # (1)
    Expression: str,
  1. See AttributeItemTypeDef

AutoMergingTypeDef#

# AutoMergingTypeDef definition

class AutoMergingTypeDef(TypedDict):
    Enabled: bool,
    Consolidation: NotRequired[ConsolidationTypeDef],  # (1)
    ConflictResolution: NotRequired[ConflictResolutionTypeDef],  # (2)
    MinAllowedConfidenceScoreForMerging: NotRequired[float],
  1. See ConsolidationTypeDef
  2. See ConflictResolutionTypeDef

GetAutoMergingPreviewRequestRequestTypeDef#

# GetAutoMergingPreviewRequestRequestTypeDef definition

class GetAutoMergingPreviewRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Consolidation: ConsolidationTypeDef,  # (1)
    ConflictResolution: ConflictResolutionTypeDef,  # (2)
    MinAllowedConfidenceScoreForMerging: NotRequired[float],
  1. See ConsolidationTypeDef
  2. See ConflictResolutionTypeDef

BatchTypeDef#

# BatchTypeDef definition

class BatchTypeDef(TypedDict):
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],

ListWorkflowsRequestRequestTypeDef#

# ListWorkflowsRequestRequestTypeDef definition

class ListWorkflowsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    WorkflowType: NotRequired[WorkflowTypeType],  # (1)
    Status: NotRequired[StatusType],  # (2)
    QueryStartDate: NotRequired[Union[datetime, str]],
    QueryEndDate: NotRequired[Union[datetime, str]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See WorkflowTypeType
  2. See StatusType

ScheduledTriggerPropertiesTypeDef#

# ScheduledTriggerPropertiesTypeDef definition

class ScheduledTriggerPropertiesTypeDef(TypedDict):
    ScheduleExpression: str,
    DataPullMode: NotRequired[DataPullModeType],  # (1)
    ScheduleStartTime: NotRequired[Union[datetime, str]],
    ScheduleEndTime: NotRequired[Union[datetime, str]],
    Timezone: NotRequired[str],
    ScheduleOffset: NotRequired[int],
    FirstExecutionFrom: NotRequired[Union[datetime, str]],
  1. See DataPullModeType

ConditionsTypeDef#

# ConditionsTypeDef definition

class ConditionsTypeDef(TypedDict):
    Range: NotRequired[RangeTypeDef],  # (1)
    ObjectCount: NotRequired[int],
    Threshold: NotRequired[ThresholdTypeDef],  # (2)
  1. See RangeTypeDef
  2. See ThresholdTypeDef

TaskTypeDef#

# TaskTypeDef definition

class TaskTypeDef(TypedDict):
    SourceFields: Sequence[str],
    TaskType: TaskTypeType,  # (3)
    ConnectorOperator: NotRequired[ConnectorOperatorTypeDef],  # (1)
    DestinationField: NotRequired[str],
    TaskProperties: NotRequired[Mapping[OperatorPropertiesKeysType, str]],  # (2)
  1. See ConnectorOperatorTypeDef
  2. See OperatorPropertiesKeysType
  3. See TaskTypeType

EventStreamSummaryTypeDef#

# EventStreamSummaryTypeDef definition

class EventStreamSummaryTypeDef(TypedDict):
    DomainName: str,
    EventStreamName: str,
    EventStreamArn: str,
    State: EventStreamStateType,  # (1)
    StoppedSince: NotRequired[datetime],
    DestinationSummary: NotRequired[DestinationSummaryTypeDef],  # (2)
    Tags: NotRequired[Dict[str, str]],
  1. See EventStreamStateType
  2. See DestinationSummaryTypeDef

DetectedProfileObjectTypeTypeDef#

# DetectedProfileObjectTypeTypeDef definition

class DetectedProfileObjectTypeTypeDef(TypedDict):
    SourceLastUpdatedTimestampFormat: NotRequired[str],
    Fields: NotRequired[Dict[str, ObjectTypeFieldTypeDef]],  # (1)
    Keys: NotRequired[Dict[str, List[ObjectTypeKeyTypeDef]]],  # (2)
  1. See ObjectTypeFieldTypeDef
  2. See ObjectTypeKeyTypeDef

GetProfileObjectTypeResponseTypeDef#

# GetProfileObjectTypeResponseTypeDef definition

class GetProfileObjectTypeResponseTypeDef(TypedDict):
    ObjectTypeName: str,
    Description: str,
    TemplateId: str,
    ExpirationDays: int,
    EncryptionKey: str,
    AllowProfileCreation: bool,
    SourceLastUpdatedTimestampFormat: str,
    Fields: Dict[str, ObjectTypeFieldTypeDef],  # (1)
    Keys: Dict[str, List[ObjectTypeKeyTypeDef]],  # (2)
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ObjectTypeFieldTypeDef
  2. See ObjectTypeKeyTypeDef
  3. See ResponseMetadataTypeDef

GetProfileObjectTypeTemplateResponseTypeDef#

# GetProfileObjectTypeTemplateResponseTypeDef definition

class GetProfileObjectTypeTemplateResponseTypeDef(TypedDict):
    TemplateId: str,
    SourceName: str,
    SourceObject: str,
    AllowProfileCreation: bool,
    SourceLastUpdatedTimestampFormat: str,
    Fields: Dict[str, ObjectTypeFieldTypeDef],  # (1)
    Keys: Dict[str, List[ObjectTypeKeyTypeDef]],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ObjectTypeFieldTypeDef
  2. See ObjectTypeKeyTypeDef
  3. See ResponseMetadataTypeDef

PutProfileObjectTypeRequestRequestTypeDef#

# PutProfileObjectTypeRequestRequestTypeDef definition

class PutProfileObjectTypeRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ObjectTypeName: str,
    Description: str,
    TemplateId: NotRequired[str],
    ExpirationDays: NotRequired[int],
    EncryptionKey: NotRequired[str],
    AllowProfileCreation: NotRequired[bool],
    SourceLastUpdatedTimestampFormat: NotRequired[str],
    Fields: NotRequired[Mapping[str, ObjectTypeFieldTypeDef]],  # (1)
    Keys: NotRequired[Mapping[str, Sequence[ObjectTypeKeyTypeDef]]],  # (2)
    Tags: NotRequired[Mapping[str, str]],
  1. See ObjectTypeFieldTypeDef
  2. See ObjectTypeKeyTypeDef

PutProfileObjectTypeResponseTypeDef#

# PutProfileObjectTypeResponseTypeDef definition

class PutProfileObjectTypeResponseTypeDef(TypedDict):
    ObjectTypeName: str,
    Description: str,
    TemplateId: str,
    ExpirationDays: int,
    EncryptionKey: str,
    AllowProfileCreation: bool,
    SourceLastUpdatedTimestampFormat: str,
    Fields: Dict[str, ObjectTypeFieldTypeDef],  # (1)
    Keys: Dict[str, List[ObjectTypeKeyTypeDef]],  # (2)
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ObjectTypeFieldTypeDef
  2. See ObjectTypeKeyTypeDef
  3. See ResponseMetadataTypeDef

GetEventStreamResponseTypeDef#

# GetEventStreamResponseTypeDef definition

class GetEventStreamResponseTypeDef(TypedDict):
    DomainName: str,
    EventStreamArn: str,
    CreatedAt: datetime,
    State: EventStreamStateType,  # (1)
    StoppedSince: datetime,
    DestinationDetails: EventStreamDestinationDetailsTypeDef,  # (2)
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See EventStreamStateType
  2. See EventStreamDestinationDetailsTypeDef
  3. See ResponseMetadataTypeDef

ExportingConfigTypeDef#

# ExportingConfigTypeDef definition

class ExportingConfigTypeDef(TypedDict):
    S3Exporting: NotRequired[S3ExportingConfigTypeDef],  # (1)
  1. See S3ExportingConfigTypeDef

ExportingLocationTypeDef#

# ExportingLocationTypeDef definition

class ExportingLocationTypeDef(TypedDict):
    S3Exporting: NotRequired[S3ExportingLocationTypeDef],  # (1)
  1. See S3ExportingLocationTypeDef

MergeProfilesRequestRequestTypeDef#

# MergeProfilesRequestRequestTypeDef definition

class MergeProfilesRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MainProfileId: str,
    ProfileIdsToBeMerged: Sequence[str],
    FieldSourceProfileIds: NotRequired[FieldSourceProfileIdsTypeDef],  # (1)
  1. See FieldSourceProfileIdsTypeDef

ProfileTypeDef#

# ProfileTypeDef definition

class ProfileTypeDef(TypedDict):
    ProfileId: NotRequired[str],
    AccountNumber: NotRequired[str],
    AdditionalInformation: NotRequired[str],
    PartyType: NotRequired[PartyTypeType],  # (1)
    BusinessName: NotRequired[str],
    FirstName: NotRequired[str],
    MiddleName: NotRequired[str],
    LastName: NotRequired[str],
    BirthDate: NotRequired[str],
    Gender: NotRequired[GenderType],  # (2)
    PhoneNumber: NotRequired[str],
    MobilePhoneNumber: NotRequired[str],
    HomePhoneNumber: NotRequired[str],
    BusinessPhoneNumber: NotRequired[str],
    EmailAddress: NotRequired[str],
    PersonalEmailAddress: NotRequired[str],
    BusinessEmailAddress: NotRequired[str],
    Address: NotRequired[AddressTypeDef],  # (3)
    ShippingAddress: NotRequired[AddressTypeDef],  # (3)
    MailingAddress: NotRequired[AddressTypeDef],  # (3)
    BillingAddress: NotRequired[AddressTypeDef],  # (3)
    Attributes: NotRequired[Dict[str, str]],
    FoundByItems: NotRequired[List[FoundByKeyValueTypeDef]],  # (7)
    PartyTypeString: NotRequired[str],
    GenderString: NotRequired[str],
  1. See PartyTypeType
  2. See GenderType
  3. See AddressTypeDef
  4. See AddressTypeDef
  5. See AddressTypeDef
  6. See AddressTypeDef
  7. See FoundByKeyValueTypeDef

GetMatchesResponseTypeDef#

# GetMatchesResponseTypeDef definition

class GetMatchesResponseTypeDef(TypedDict):
    NextToken: str,
    MatchGenerationDate: datetime,
    PotentialMatches: int,
    Matches: List[MatchItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MatchItemTypeDef
  2. See ResponseMetadataTypeDef

ListAccountIntegrationsResponseTypeDef#

# ListAccountIntegrationsResponseTypeDef definition

class ListAccountIntegrationsResponseTypeDef(TypedDict):
    Items: List[ListIntegrationItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListIntegrationItemTypeDef
  2. See ResponseMetadataTypeDef

ListIntegrationsResponseTypeDef#

# ListIntegrationsResponseTypeDef definition

class ListIntegrationsResponseTypeDef(TypedDict):
    Items: List[ListIntegrationItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListIntegrationItemTypeDef
  2. See ResponseMetadataTypeDef

ListCalculatedAttributeDefinitionsResponseTypeDef#

# ListCalculatedAttributeDefinitionsResponseTypeDef definition

class ListCalculatedAttributeDefinitionsResponseTypeDef(TypedDict):
    Items: List[ListCalculatedAttributeDefinitionItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListCalculatedAttributeDefinitionItemTypeDef
  2. See ResponseMetadataTypeDef

ListCalculatedAttributesForProfileResponseTypeDef#

# ListCalculatedAttributesForProfileResponseTypeDef definition

class ListCalculatedAttributesForProfileResponseTypeDef(TypedDict):
    Items: List[ListCalculatedAttributeForProfileItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListCalculatedAttributeForProfileItemTypeDef
  2. See ResponseMetadataTypeDef

ListDomainsResponseTypeDef#

# ListDomainsResponseTypeDef definition

class ListDomainsResponseTypeDef(TypedDict):
    Items: List[ListDomainItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListDomainItemTypeDef
  2. See ResponseMetadataTypeDef

ListEventStreamsRequestListEventStreamsPaginateTypeDef#

# ListEventStreamsRequestListEventStreamsPaginateTypeDef definition

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

ListProfileObjectTypesResponseTypeDef#

# ListProfileObjectTypesResponseTypeDef definition

class ListProfileObjectTypesResponseTypeDef(TypedDict):
    Items: List[ListProfileObjectTypeItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListProfileObjectTypeItemTypeDef
  2. See ResponseMetadataTypeDef

ListProfileObjectTypeTemplatesResponseTypeDef#

# ListProfileObjectTypeTemplatesResponseTypeDef definition

class ListProfileObjectTypeTemplatesResponseTypeDef(TypedDict):
    Items: List[ListProfileObjectTypeTemplateItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListProfileObjectTypeTemplateItemTypeDef
  2. See ResponseMetadataTypeDef

ListProfileObjectsResponseTypeDef#

# ListProfileObjectsResponseTypeDef definition

class ListProfileObjectsResponseTypeDef(TypedDict):
    Items: List[ListProfileObjectsItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListProfileObjectsItemTypeDef
  2. See ResponseMetadataTypeDef

ListProfileObjectsRequestRequestTypeDef#

# ListProfileObjectsRequestRequestTypeDef definition

class ListProfileObjectsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ObjectTypeName: str,
    ProfileId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    ObjectFilter: NotRequired[ObjectFilterTypeDef],  # (1)
  1. See ObjectFilterTypeDef

ListWorkflowsResponseTypeDef#

# ListWorkflowsResponseTypeDef definition

class ListWorkflowsResponseTypeDef(TypedDict):
    Items: List[ListWorkflowsItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListWorkflowsItemTypeDef
  2. See ResponseMetadataTypeDef

SourceConnectorPropertiesTypeDef#

# SourceConnectorPropertiesTypeDef definition

class SourceConnectorPropertiesTypeDef(TypedDict):
    Marketo: NotRequired[MarketoSourcePropertiesTypeDef],  # (1)
    S3: NotRequired[S3SourcePropertiesTypeDef],  # (2)
    Salesforce: NotRequired[SalesforceSourcePropertiesTypeDef],  # (3)
    ServiceNow: NotRequired[ServiceNowSourcePropertiesTypeDef],  # (4)
    Zendesk: NotRequired[ZendeskSourcePropertiesTypeDef],  # (5)
  1. See MarketoSourcePropertiesTypeDef
  2. See S3SourcePropertiesTypeDef
  3. See SalesforceSourcePropertiesTypeDef
  4. See ServiceNowSourcePropertiesTypeDef
  5. See ZendeskSourcePropertiesTypeDef

UpdateProfileRequestRequestTypeDef#

# UpdateProfileRequestRequestTypeDef definition

class UpdateProfileRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ProfileId: str,
    AdditionalInformation: NotRequired[str],
    AccountNumber: NotRequired[str],
    PartyType: NotRequired[PartyTypeType],  # (1)
    BusinessName: NotRequired[str],
    FirstName: NotRequired[str],
    MiddleName: NotRequired[str],
    LastName: NotRequired[str],
    BirthDate: NotRequired[str],
    Gender: NotRequired[GenderType],  # (2)
    PhoneNumber: NotRequired[str],
    MobilePhoneNumber: NotRequired[str],
    HomePhoneNumber: NotRequired[str],
    BusinessPhoneNumber: NotRequired[str],
    EmailAddress: NotRequired[str],
    PersonalEmailAddress: NotRequired[str],
    BusinessEmailAddress: NotRequired[str],
    Address: NotRequired[UpdateAddressTypeDef],  # (3)
    ShippingAddress: NotRequired[UpdateAddressTypeDef],  # (3)
    MailingAddress: NotRequired[UpdateAddressTypeDef],  # (3)
    BillingAddress: NotRequired[UpdateAddressTypeDef],  # (3)
    Attributes: NotRequired[Mapping[str, str]],
    PartyTypeString: NotRequired[str],
    GenderString: NotRequired[str],
  1. See PartyTypeType
  2. See GenderType
  3. See UpdateAddressTypeDef
  4. See UpdateAddressTypeDef
  5. See UpdateAddressTypeDef
  6. See UpdateAddressTypeDef

GetWorkflowResponseTypeDef#

# GetWorkflowResponseTypeDef definition

class GetWorkflowResponseTypeDef(TypedDict):
    WorkflowId: str,
    WorkflowType: WorkflowTypeType,  # (1)
    Status: StatusType,  # (2)
    ErrorDescription: str,
    StartDate: datetime,
    LastUpdatedAt: datetime,
    Attributes: WorkflowAttributesTypeDef,  # (3)
    Metrics: WorkflowMetricsTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See WorkflowTypeType
  2. See StatusType
  3. See WorkflowAttributesTypeDef
  4. See WorkflowMetricsTypeDef
  5. See ResponseMetadataTypeDef

GetWorkflowStepsResponseTypeDef#

# GetWorkflowStepsResponseTypeDef definition

class GetWorkflowStepsResponseTypeDef(TypedDict):
    WorkflowId: str,
    WorkflowType: WorkflowTypeType,  # (1)
    Items: List[WorkflowStepItemTypeDef],  # (2)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See WorkflowTypeType
  2. See WorkflowStepItemTypeDef
  3. See ResponseMetadataTypeDef

TriggerPropertiesTypeDef#

# TriggerPropertiesTypeDef definition

class TriggerPropertiesTypeDef(TypedDict):
    Scheduled: NotRequired[ScheduledTriggerPropertiesTypeDef],  # (1)
  1. See ScheduledTriggerPropertiesTypeDef

CreateCalculatedAttributeDefinitionRequestRequestTypeDef#

# CreateCalculatedAttributeDefinitionRequestRequestTypeDef definition

class CreateCalculatedAttributeDefinitionRequestRequestTypeDef(TypedDict):
    DomainName: str,
    CalculatedAttributeName: str,
    AttributeDetails: AttributeDetailsTypeDef,  # (1)
    Statistic: StatisticType,  # (2)
    DisplayName: NotRequired[str],
    Description: NotRequired[str],
    Conditions: NotRequired[ConditionsTypeDef],  # (3)
    Tags: NotRequired[Mapping[str, str]],
  1. See AttributeDetailsTypeDef
  2. See StatisticType
  3. See ConditionsTypeDef

CreateCalculatedAttributeDefinitionResponseTypeDef#

# CreateCalculatedAttributeDefinitionResponseTypeDef definition

class CreateCalculatedAttributeDefinitionResponseTypeDef(TypedDict):
    CalculatedAttributeName: str,
    DisplayName: str,
    Description: str,
    AttributeDetails: AttributeDetailsTypeDef,  # (1)
    Conditions: ConditionsTypeDef,  # (2)
    Statistic: StatisticType,  # (3)
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See AttributeDetailsTypeDef
  2. See ConditionsTypeDef
  3. See StatisticType
  4. See ResponseMetadataTypeDef

GetCalculatedAttributeDefinitionResponseTypeDef#

# GetCalculatedAttributeDefinitionResponseTypeDef definition

class GetCalculatedAttributeDefinitionResponseTypeDef(TypedDict):
    CalculatedAttributeName: str,
    DisplayName: str,
    Description: str,
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    Statistic: StatisticType,  # (1)
    Conditions: ConditionsTypeDef,  # (2)
    AttributeDetails: AttributeDetailsTypeDef,  # (3)
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See StatisticType
  2. See ConditionsTypeDef
  3. See AttributeDetailsTypeDef
  4. See ResponseMetadataTypeDef

UpdateCalculatedAttributeDefinitionRequestRequestTypeDef#

# UpdateCalculatedAttributeDefinitionRequestRequestTypeDef definition

class UpdateCalculatedAttributeDefinitionRequestRequestTypeDef(TypedDict):
    DomainName: str,
    CalculatedAttributeName: str,
    DisplayName: NotRequired[str],
    Description: NotRequired[str],
    Conditions: NotRequired[ConditionsTypeDef],  # (1)
  1. See ConditionsTypeDef

UpdateCalculatedAttributeDefinitionResponseTypeDef#

# UpdateCalculatedAttributeDefinitionResponseTypeDef definition

class UpdateCalculatedAttributeDefinitionResponseTypeDef(TypedDict):
    CalculatedAttributeName: str,
    DisplayName: str,
    Description: str,
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    Statistic: StatisticType,  # (1)
    Conditions: ConditionsTypeDef,  # (2)
    AttributeDetails: AttributeDetailsTypeDef,  # (3)
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See StatisticType
  2. See ConditionsTypeDef
  3. See AttributeDetailsTypeDef
  4. See ResponseMetadataTypeDef

ListEventStreamsResponseTypeDef#

# ListEventStreamsResponseTypeDef definition

class ListEventStreamsResponseTypeDef(TypedDict):
    Items: List[EventStreamSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventStreamSummaryTypeDef
  2. See ResponseMetadataTypeDef

DetectProfileObjectTypeResponseTypeDef#

# DetectProfileObjectTypeResponseTypeDef definition

class DetectProfileObjectTypeResponseTypeDef(TypedDict):
    DetectedProfileObjectTypes: List[DetectedProfileObjectTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DetectedProfileObjectTypeTypeDef
  2. See ResponseMetadataTypeDef

MatchingRequestTypeDef#

# MatchingRequestTypeDef definition

class MatchingRequestTypeDef(TypedDict):
    Enabled: bool,
    JobSchedule: NotRequired[JobScheduleTypeDef],  # (1)
    AutoMerging: NotRequired[AutoMergingTypeDef],  # (2)
    ExportingConfig: NotRequired[ExportingConfigTypeDef],  # (3)
  1. See JobScheduleTypeDef
  2. See AutoMergingTypeDef
  3. See ExportingConfigTypeDef

MatchingResponseTypeDef#

# MatchingResponseTypeDef definition

class MatchingResponseTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    JobSchedule: NotRequired[JobScheduleTypeDef],  # (1)
    AutoMerging: NotRequired[AutoMergingTypeDef],  # (2)
    ExportingConfig: NotRequired[ExportingConfigTypeDef],  # (3)
  1. See JobScheduleTypeDef
  2. See AutoMergingTypeDef
  3. See ExportingConfigTypeDef

RuleBasedMatchingRequestTypeDef#

# RuleBasedMatchingRequestTypeDef definition

class RuleBasedMatchingRequestTypeDef(TypedDict):
    Enabled: bool,
    MatchingRules: NotRequired[Sequence[MatchingRuleTypeDef]],  # (1)
    MaxAllowedRuleLevelForMerging: NotRequired[int],
    MaxAllowedRuleLevelForMatching: NotRequired[int],
    AttributeTypesSelector: NotRequired[AttributeTypesSelectorTypeDef],  # (2)
    ConflictResolution: NotRequired[ConflictResolutionTypeDef],  # (3)
    ExportingConfig: NotRequired[ExportingConfigTypeDef],  # (4)
  1. See MatchingRuleTypeDef
  2. See AttributeTypesSelectorTypeDef
  3. See ConflictResolutionTypeDef
  4. See ExportingConfigTypeDef

RuleBasedMatchingResponseTypeDef#

# RuleBasedMatchingResponseTypeDef definition

class RuleBasedMatchingResponseTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    MatchingRules: NotRequired[List[MatchingRuleTypeDef]],  # (1)
    Status: NotRequired[RuleBasedMatchingStatusType],  # (2)
    MaxAllowedRuleLevelForMerging: NotRequired[int],
    MaxAllowedRuleLevelForMatching: NotRequired[int],
    AttributeTypesSelector: NotRequired[AttributeTypesSelectorTypeDef],  # (3)
    ConflictResolution: NotRequired[ConflictResolutionTypeDef],  # (4)
    ExportingConfig: NotRequired[ExportingConfigTypeDef],  # (5)
  1. See MatchingRuleTypeDef
  2. See RuleBasedMatchingStatusType
  3. See AttributeTypesSelectorTypeDef
  4. See ConflictResolutionTypeDef
  5. See ExportingConfigTypeDef

GetIdentityResolutionJobResponseTypeDef#

# GetIdentityResolutionJobResponseTypeDef definition

class GetIdentityResolutionJobResponseTypeDef(TypedDict):
    DomainName: str,
    JobId: str,
    Status: IdentityResolutionJobStatusType,  # (1)
    Message: str,
    JobStartTime: datetime,
    JobEndTime: datetime,
    LastUpdatedAt: datetime,
    JobExpirationTime: datetime,
    AutoMerging: AutoMergingTypeDef,  # (2)
    ExportingLocation: ExportingLocationTypeDef,  # (3)
    JobStats: JobStatsTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See IdentityResolutionJobStatusType
  2. See AutoMergingTypeDef
  3. See ExportingLocationTypeDef
  4. See JobStatsTypeDef
  5. See ResponseMetadataTypeDef

IdentityResolutionJobTypeDef#

# IdentityResolutionJobTypeDef definition

class IdentityResolutionJobTypeDef(TypedDict):
    DomainName: NotRequired[str],
    JobId: NotRequired[str],
    Status: NotRequired[IdentityResolutionJobStatusType],  # (1)
    JobStartTime: NotRequired[datetime],
    JobEndTime: NotRequired[datetime],
    JobStats: NotRequired[JobStatsTypeDef],  # (2)
    ExportingLocation: NotRequired[ExportingLocationTypeDef],  # (3)
    Message: NotRequired[str],
  1. See IdentityResolutionJobStatusType
  2. See JobStatsTypeDef
  3. See ExportingLocationTypeDef

SearchProfilesResponseTypeDef#

# SearchProfilesResponseTypeDef definition

class SearchProfilesResponseTypeDef(TypedDict):
    Items: List[ProfileTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProfileTypeDef
  2. See ResponseMetadataTypeDef

SourceFlowConfigTypeDef#

# SourceFlowConfigTypeDef definition

class SourceFlowConfigTypeDef(TypedDict):
    ConnectorType: SourceConnectorTypeType,  # (1)
    SourceConnectorProperties: SourceConnectorPropertiesTypeDef,  # (3)
    ConnectorProfileName: NotRequired[str],
    IncrementalPullConfig: NotRequired[IncrementalPullConfigTypeDef],  # (2)
  1. See SourceConnectorTypeType
  2. See IncrementalPullConfigTypeDef
  3. See SourceConnectorPropertiesTypeDef

TriggerConfigTypeDef#

# TriggerConfigTypeDef definition

class TriggerConfigTypeDef(TypedDict):
    TriggerType: TriggerTypeType,  # (1)
    TriggerProperties: NotRequired[TriggerPropertiesTypeDef],  # (2)
  1. See TriggerTypeType
  2. See TriggerPropertiesTypeDef

CreateDomainRequestRequestTypeDef#

# CreateDomainRequestRequestTypeDef definition

class CreateDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,
    DefaultExpirationDays: int,
    DefaultEncryptionKey: NotRequired[str],
    DeadLetterQueueUrl: NotRequired[str],
    Matching: NotRequired[MatchingRequestTypeDef],  # (1)
    RuleBasedMatching: NotRequired[RuleBasedMatchingRequestTypeDef],  # (2)
    Tags: NotRequired[Mapping[str, str]],
  1. See MatchingRequestTypeDef
  2. See RuleBasedMatchingRequestTypeDef

UpdateDomainRequestRequestTypeDef#

# UpdateDomainRequestRequestTypeDef definition

class UpdateDomainRequestRequestTypeDef(TypedDict):
    DomainName: str,
    DefaultExpirationDays: NotRequired[int],
    DefaultEncryptionKey: NotRequired[str],
    DeadLetterQueueUrl: NotRequired[str],
    Matching: NotRequired[MatchingRequestTypeDef],  # (1)
    RuleBasedMatching: NotRequired[RuleBasedMatchingRequestTypeDef],  # (2)
    Tags: NotRequired[Mapping[str, str]],
  1. See MatchingRequestTypeDef
  2. See RuleBasedMatchingRequestTypeDef

CreateDomainResponseTypeDef#

# CreateDomainResponseTypeDef definition

class CreateDomainResponseTypeDef(TypedDict):
    DomainName: str,
    DefaultExpirationDays: int,
    DefaultEncryptionKey: str,
    DeadLetterQueueUrl: str,
    Matching: MatchingResponseTypeDef,  # (1)
    RuleBasedMatching: RuleBasedMatchingResponseTypeDef,  # (2)
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See MatchingResponseTypeDef
  2. See RuleBasedMatchingResponseTypeDef
  3. See ResponseMetadataTypeDef

GetDomainResponseTypeDef#

# GetDomainResponseTypeDef definition

class GetDomainResponseTypeDef(TypedDict):
    DomainName: str,
    DefaultExpirationDays: int,
    DefaultEncryptionKey: str,
    DeadLetterQueueUrl: str,
    Stats: DomainStatsTypeDef,  # (1)
    Matching: MatchingResponseTypeDef,  # (2)
    RuleBasedMatching: RuleBasedMatchingResponseTypeDef,  # (3)
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DomainStatsTypeDef
  2. See MatchingResponseTypeDef
  3. See RuleBasedMatchingResponseTypeDef
  4. See ResponseMetadataTypeDef

UpdateDomainResponseTypeDef#

# UpdateDomainResponseTypeDef definition

class UpdateDomainResponseTypeDef(TypedDict):
    DomainName: str,
    DefaultExpirationDays: int,
    DefaultEncryptionKey: str,
    DeadLetterQueueUrl: str,
    Matching: MatchingResponseTypeDef,  # (1)
    RuleBasedMatching: RuleBasedMatchingResponseTypeDef,  # (2)
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See MatchingResponseTypeDef
  2. See RuleBasedMatchingResponseTypeDef
  3. See ResponseMetadataTypeDef

ListIdentityResolutionJobsResponseTypeDef#

# ListIdentityResolutionJobsResponseTypeDef definition

class ListIdentityResolutionJobsResponseTypeDef(TypedDict):
    IdentityResolutionJobsList: List[IdentityResolutionJobTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdentityResolutionJobTypeDef
  2. See ResponseMetadataTypeDef

FlowDefinitionTypeDef#

# FlowDefinitionTypeDef definition

class FlowDefinitionTypeDef(TypedDict):
    FlowName: str,
    KmsArn: str,
    SourceFlowConfig: SourceFlowConfigTypeDef,  # (1)
    Tasks: Sequence[TaskTypeDef],  # (2)
    TriggerConfig: TriggerConfigTypeDef,  # (3)
    Description: NotRequired[str],
  1. See SourceFlowConfigTypeDef
  2. See TaskTypeDef
  3. See TriggerConfigTypeDef

AppflowIntegrationTypeDef#

# AppflowIntegrationTypeDef definition

class AppflowIntegrationTypeDef(TypedDict):
    FlowDefinition: FlowDefinitionTypeDef,  # (1)
    Batches: NotRequired[Sequence[BatchTypeDef]],  # (2)
  1. See FlowDefinitionTypeDef
  2. See BatchTypeDef

PutIntegrationRequestRequestTypeDef#

# PutIntegrationRequestRequestTypeDef definition

class PutIntegrationRequestRequestTypeDef(TypedDict):
    DomainName: str,
    Uri: NotRequired[str],
    ObjectTypeName: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
    FlowDefinition: NotRequired[FlowDefinitionTypeDef],  # (1)
    ObjectTypeNames: NotRequired[Mapping[str, str]],
  1. See FlowDefinitionTypeDef

IntegrationConfigTypeDef#

# IntegrationConfigTypeDef definition

class IntegrationConfigTypeDef(TypedDict):
    AppflowIntegration: NotRequired[AppflowIntegrationTypeDef],  # (1)
  1. See AppflowIntegrationTypeDef

CreateIntegrationWorkflowRequestRequestTypeDef#

# CreateIntegrationWorkflowRequestRequestTypeDef definition

class CreateIntegrationWorkflowRequestRequestTypeDef(TypedDict):
    DomainName: str,
    WorkflowType: WorkflowTypeType,  # (1)
    IntegrationConfig: IntegrationConfigTypeDef,  # (2)
    ObjectTypeName: str,
    RoleArn: str,
    Tags: NotRequired[Mapping[str, str]],
  1. See WorkflowTypeType
  2. See IntegrationConfigTypeDef