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,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
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],
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,
- 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]],
ConflictResolutionTypeDef#
# ConflictResolutionTypeDef definition
class ConflictResolutionTypeDef(TypedDict):
ConflictResolvingModel: ConflictResolvingModelType, # (1)
SourceName: NotRequired[str],
ConsolidationTypeDef#
# ConsolidationTypeDef definition
class ConsolidationTypeDef(TypedDict):
MatchingAttributesList: Sequence[Sequence[str]],
RangeTypeDef#
# RangeTypeDef definition
class RangeTypeDef(TypedDict):
Value: int,
Unit: UnitType, # (1)
- See UnitType
ThresholdTypeDef#
# ThresholdTypeDef definition
class ThresholdTypeDef(TypedDict):
Value: str,
Operator: OperatorType, # (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)
- See MarketoConnectorOperatorType
- See S3ConnectorOperatorType
- See SalesforceConnectorOperatorType
- See ServiceNowConnectorOperatorType
- 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],
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)
ObjectTypeKeyTypeDef#
# ObjectTypeKeyTypeDef definition
class ObjectTypeKeyTypeDef(TypedDict):
StandardIdentifiers: NotRequired[List[StandardIdentifierType]], # (1)
FieldNames: NotRequired[List[str]],
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],
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],