Typed dictionaries
Index > CustomerProfiles > Typed dictionaries
Auto-generated documentation for CustomerProfiles type annotations stubs module mypy-boto3-customer-profiles.
AddProfileKeyRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import AddProfileKeyRequestRequestTypeDef
def get_value() -> AddProfileKeyRequestRequestTypeDef:
return {
"ProfileId": ...,
"KeyName": ...,
"Values": ...,
"DomainName": ...,
}
Definition
class AddProfileKeyRequestRequestTypeDef(TypedDict):
ProfileId: str,
KeyName: str,
Values: Sequence[str],
DomainName: str,
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
AdditionalSearchKeyTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import AdditionalSearchKeyTypeDef
def get_value() -> AdditionalSearchKeyTypeDef:
return {
"KeyName": ...,
"Values": ...,
}
AddressTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import AddressTypeDef
def get_value() -> AddressTypeDef:
return {
"Address1": ...,
}
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],
BatchTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import BatchTypeDef
def get_value() -> BatchTypeDef:
return {
"StartTime": ...,
"EndTime": ...,
}
Definition
class BatchTypeDef(TypedDict):
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
AppflowIntegrationWorkflowAttributesTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import AppflowIntegrationWorkflowAttributesTypeDef
def get_value() -> AppflowIntegrationWorkflowAttributesTypeDef:
return {
"SourceConnectorType": ...,
"ConnectorProfileName": ...,
}
Definition
class AppflowIntegrationWorkflowAttributesTypeDef(TypedDict):
SourceConnectorType: SourceConnectorTypeType, # (1)
ConnectorProfileName: str,
RoleArn: NotRequired[str],
AppflowIntegrationWorkflowMetricsTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import AppflowIntegrationWorkflowMetricsTypeDef
def get_value() -> AppflowIntegrationWorkflowMetricsTypeDef:
return {
"RecordsProcessed": ...,
"StepsCompleted": ...,
"TotalSteps": ...,
}
Definition
class AppflowIntegrationWorkflowMetricsTypeDef(TypedDict):
RecordsProcessed: int,
StepsCompleted: int,
TotalSteps: int,
AppflowIntegrationWorkflowStepTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import AppflowIntegrationWorkflowStepTypeDef
def get_value() -> AppflowIntegrationWorkflowStepTypeDef:
return {
"FlowName": ...,
"Status": ...,
"ExecutionMessage": ...,
"RecordsProcessed": ...,
"BatchRecordsStartTime": ...,
"BatchRecordsEndTime": ...,
"CreatedAt": ...,
"LastUpdatedAt": ...,
}
Definition
class AppflowIntegrationWorkflowStepTypeDef(TypedDict):
FlowName: str,
Status: StatusType, # (1)
ExecutionMessage: str,
RecordsProcessed: int,
BatchRecordsStartTime: str,
BatchRecordsEndTime: str,
CreatedAt: datetime,
LastUpdatedAt: datetime,
- See StatusType
ConflictResolutionTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ConflictResolutionTypeDef
def get_value() -> ConflictResolutionTypeDef:
return {
"ConflictResolvingModel": ...,
}
Definition
class ConflictResolutionTypeDef(TypedDict):
ConflictResolvingModel: ConflictResolvingModelType, # (1)
SourceName: NotRequired[str],
ConsolidationTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ConsolidationTypeDef
def get_value() -> ConsolidationTypeDef:
return {
"MatchingAttributesList": ...,
}
ConnectorOperatorTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ConnectorOperatorTypeDef
def get_value() -> ConnectorOperatorTypeDef:
return {
"Marketo": ...,
}
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
DeleteDomainRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteDomainRequestRequestTypeDef
def get_value() -> DeleteDomainRequestRequestTypeDef:
return {
"DomainName": ...,
}
DeleteIntegrationRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteIntegrationRequestRequestTypeDef
def get_value() -> DeleteIntegrationRequestRequestTypeDef:
return {
"DomainName": ...,
"Uri": ...,
}
DeleteProfileKeyRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteProfileKeyRequestRequestTypeDef
def get_value() -> DeleteProfileKeyRequestRequestTypeDef:
return {
"ProfileId": ...,
"KeyName": ...,
"Values": ...,
"DomainName": ...,
}
Definition
class DeleteProfileKeyRequestRequestTypeDef(TypedDict):
ProfileId: str,
KeyName: str,
Values: Sequence[str],
DomainName: str,
DeleteProfileObjectRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteProfileObjectRequestRequestTypeDef
def get_value() -> DeleteProfileObjectRequestRequestTypeDef:
return {
"ProfileId": ...,
"ProfileObjectUniqueKey": ...,
"ObjectTypeName": ...,
"DomainName": ...,
}
Definition
class DeleteProfileObjectRequestRequestTypeDef(TypedDict):
ProfileId: str,
ProfileObjectUniqueKey: str,
ObjectTypeName: str,
DomainName: str,
DeleteProfileObjectTypeRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteProfileObjectTypeRequestRequestTypeDef
def get_value() -> DeleteProfileObjectTypeRequestRequestTypeDef:
return {
"DomainName": ...,
"ObjectTypeName": ...,
}
Definition
class DeleteProfileObjectTypeRequestRequestTypeDef(TypedDict):
DomainName: str,
ObjectTypeName: str,
DeleteProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteProfileRequestRequestTypeDef
def get_value() -> DeleteProfileRequestRequestTypeDef:
return {
"ProfileId": ...,
"DomainName": ...,
}
DeleteWorkflowRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteWorkflowRequestRequestTypeDef
def get_value() -> DeleteWorkflowRequestRequestTypeDef:
return {
"DomainName": ...,
"WorkflowId": ...,
}
DomainStatsTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DomainStatsTypeDef
def get_value() -> DomainStatsTypeDef:
return {
"ProfileCount": ...,
}
Definition
class DomainStatsTypeDef(TypedDict):
ProfileCount: NotRequired[int],
MeteringProfileCount: NotRequired[int],
ObjectCount: NotRequired[int],
TotalSize: NotRequired[int],
S3ExportingConfigTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import S3ExportingConfigTypeDef
def get_value() -> S3ExportingConfigTypeDef:
return {
"S3BucketName": ...,
}
Definition
class S3ExportingConfigTypeDef(TypedDict):
S3BucketName: str,
S3KeyName: NotRequired[str],
S3ExportingLocationTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import S3ExportingLocationTypeDef
def get_value() -> S3ExportingLocationTypeDef:
return {
"S3BucketName": ...,
}
Definition
class S3ExportingLocationTypeDef(TypedDict):
S3BucketName: NotRequired[str],
S3KeyName: NotRequired[str],
FieldSourceProfileIdsTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import FieldSourceProfileIdsTypeDef
def get_value() -> FieldSourceProfileIdsTypeDef:
return {
"AccountNumber": ...,
}
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
Usage Example
from mypy_boto3_customer_profiles.type_defs import FoundByKeyValueTypeDef
def get_value() -> FoundByKeyValueTypeDef:
return {
"KeyName": ...,
}
Definition
class FoundByKeyValueTypeDef(TypedDict):
KeyName: NotRequired[str],
Values: NotRequired[List[str]],
GetDomainRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetDomainRequestRequestTypeDef
def get_value() -> GetDomainRequestRequestTypeDef:
return {
"DomainName": ...,
}
GetIdentityResolutionJobRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetIdentityResolutionJobRequestRequestTypeDef
def get_value() -> GetIdentityResolutionJobRequestRequestTypeDef:
return {
"DomainName": ...,
"JobId": ...,
}
Definition
class GetIdentityResolutionJobRequestRequestTypeDef(TypedDict):
DomainName: str,
JobId: str,
JobStatsTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import JobStatsTypeDef
def get_value() -> JobStatsTypeDef:
return {
"NumberOfProfilesReviewed": ...,
}
Definition
class JobStatsTypeDef(TypedDict):
NumberOfProfilesReviewed: NotRequired[int],
NumberOfMatchesFound: NotRequired[int],
NumberOfMergesDone: NotRequired[int],
GetIntegrationRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetIntegrationRequestRequestTypeDef
def get_value() -> GetIntegrationRequestRequestTypeDef:
return {
"DomainName": ...,
"Uri": ...,
}
GetMatchesRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetMatchesRequestRequestTypeDef
def get_value() -> GetMatchesRequestRequestTypeDef:
return {
"DomainName": ...,
}
Definition
class GetMatchesRequestRequestTypeDef(TypedDict):
DomainName: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
MatchItemTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import MatchItemTypeDef
def get_value() -> MatchItemTypeDef:
return {
"MatchId": ...,
}
Definition
class MatchItemTypeDef(TypedDict):
MatchId: NotRequired[str],
ProfileIds: NotRequired[List[str]],
ConfidenceScore: NotRequired[float],
GetProfileObjectTypeRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetProfileObjectTypeRequestRequestTypeDef
def get_value() -> GetProfileObjectTypeRequestRequestTypeDef:
return {
"DomainName": ...,
"ObjectTypeName": ...,
}
Definition
class GetProfileObjectTypeRequestRequestTypeDef(TypedDict):
DomainName: str,
ObjectTypeName: str,
ObjectTypeFieldTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ObjectTypeFieldTypeDef
def get_value() -> ObjectTypeFieldTypeDef:
return {
"Source": ...,
}
Definition
class ObjectTypeFieldTypeDef(TypedDict):
Source: NotRequired[str],
Target: NotRequired[str],
ContentType: NotRequired[FieldContentTypeType], # (1)
ObjectTypeKeyTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ObjectTypeKeyTypeDef
def get_value() -> ObjectTypeKeyTypeDef:
return {
"StandardIdentifiers": ...,
}
Definition
class ObjectTypeKeyTypeDef(TypedDict):
StandardIdentifiers: NotRequired[List[StandardIdentifierType]], # (1)
FieldNames: NotRequired[List[str]],
GetProfileObjectTypeTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetProfileObjectTypeTemplateRequestRequestTypeDef
def get_value() -> GetProfileObjectTypeTemplateRequestRequestTypeDef:
return {
"TemplateId": ...,
}
GetWorkflowRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetWorkflowRequestRequestTypeDef
def get_value() -> GetWorkflowRequestRequestTypeDef:
return {
"DomainName": ...,
"WorkflowId": ...,
}
GetWorkflowStepsRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetWorkflowStepsRequestRequestTypeDef
def get_value() -> GetWorkflowStepsRequestRequestTypeDef:
return {
"DomainName": ...,
"WorkflowId": ...,
}
Definition
class GetWorkflowStepsRequestRequestTypeDef(TypedDict):
DomainName: str,
WorkflowId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
IncrementalPullConfigTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import IncrementalPullConfigTypeDef
def get_value() -> IncrementalPullConfigTypeDef:
return {
"DatetimeTypeFieldName": ...,
}
JobScheduleTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import JobScheduleTypeDef
def get_value() -> JobScheduleTypeDef:
return {
"DayOfTheWeek": ...,
"Time": ...,
}
Definition
class JobScheduleTypeDef(TypedDict):
DayOfTheWeek: JobScheduleDayOfTheWeekType, # (1)
Time: str,
ListAccountIntegrationsRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListAccountIntegrationsRequestRequestTypeDef
def get_value() -> ListAccountIntegrationsRequestRequestTypeDef:
return {
"Uri": ...,
}
Definition
class ListAccountIntegrationsRequestRequestTypeDef(TypedDict):
Uri: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
IncludeHidden: NotRequired[bool],
ListIntegrationItemTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListIntegrationItemTypeDef
def get_value() -> ListIntegrationItemTypeDef:
return {
"DomainName": ...,
"Uri": ...,
"CreatedAt": ...,
"LastUpdatedAt": ...,
}
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],
ListDomainItemTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListDomainItemTypeDef
def get_value() -> ListDomainItemTypeDef:
return {
"DomainName": ...,
"CreatedAt": ...,
"LastUpdatedAt": ...,
}
Definition
class ListDomainItemTypeDef(TypedDict):
DomainName: str,
CreatedAt: datetime,
LastUpdatedAt: datetime,
Tags: NotRequired[Dict[str, str]],
ListDomainsRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListDomainsRequestRequestTypeDef
def get_value() -> ListDomainsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListDomainsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListIdentityResolutionJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListIdentityResolutionJobsRequestRequestTypeDef
def get_value() -> ListIdentityResolutionJobsRequestRequestTypeDef:
return {
"DomainName": ...,
}
Definition
class ListIdentityResolutionJobsRequestRequestTypeDef(TypedDict):
DomainName: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListIntegrationsRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListIntegrationsRequestRequestTypeDef
def get_value() -> ListIntegrationsRequestRequestTypeDef:
return {
"DomainName": ...,
}
Definition
class ListIntegrationsRequestRequestTypeDef(TypedDict):
DomainName: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
IncludeHidden: NotRequired[bool],
ListProfileObjectTypeItemTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListProfileObjectTypeItemTypeDef
def get_value() -> ListProfileObjectTypeItemTypeDef:
return {
"ObjectTypeName": ...,
"Description": ...,
}
Definition
class ListProfileObjectTypeItemTypeDef(TypedDict):
ObjectTypeName: str,
Description: str,
CreatedAt: NotRequired[datetime],
LastUpdatedAt: NotRequired[datetime],
Tags: NotRequired[Dict[str, str]],
ListProfileObjectTypeTemplateItemTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListProfileObjectTypeTemplateItemTypeDef
def get_value() -> ListProfileObjectTypeTemplateItemTypeDef:
return {
"TemplateId": ...,
}
Definition
class ListProfileObjectTypeTemplateItemTypeDef(TypedDict):
TemplateId: NotRequired[str],
SourceName: NotRequired[str],
SourceObject: NotRequired[str],
ListProfileObjectTypeTemplatesRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListProfileObjectTypeTemplatesRequestRequestTypeDef
def get_value() -> ListProfileObjectTypeTemplatesRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListProfileObjectTypeTemplatesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListProfileObjectTypesRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListProfileObjectTypesRequestRequestTypeDef
def get_value() -> ListProfileObjectTypesRequestRequestTypeDef:
return {
"DomainName": ...,
}
Definition
class ListProfileObjectTypesRequestRequestTypeDef(TypedDict):
DomainName: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListProfileObjectsItemTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListProfileObjectsItemTypeDef
def get_value() -> ListProfileObjectsItemTypeDef:
return {
"ObjectTypeName": ...,
}
Definition
class ListProfileObjectsItemTypeDef(TypedDict):
ObjectTypeName: NotRequired[str],
ProfileObjectUniqueKey: NotRequired[str],
Object: NotRequired[str],
ObjectFilterTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ObjectFilterTypeDef
def get_value() -> ObjectFilterTypeDef:
return {
"KeyName": ...,
"Values": ...,
}
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
ListWorkflowsItemTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListWorkflowsItemTypeDef
def get_value() -> ListWorkflowsItemTypeDef:
return {
"WorkflowType": ...,
"WorkflowId": ...,
"Status": ...,
"StatusDescription": ...,
"CreatedAt": ...,
"LastUpdatedAt": ...,
}
Definition
class ListWorkflowsItemTypeDef(TypedDict):
WorkflowType: WorkflowTypeType, # (1)
WorkflowId: str,
Status: StatusType, # (2)
StatusDescription: str,
CreatedAt: datetime,
LastUpdatedAt: datetime,
- See WorkflowTypeType
- See StatusType
ListWorkflowsRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListWorkflowsRequestRequestTypeDef
def get_value() -> ListWorkflowsRequestRequestTypeDef:
return {
"DomainName": ...,
}
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],
- See WorkflowTypeType
- See StatusType
MarketoSourcePropertiesTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import MarketoSourcePropertiesTypeDef
def get_value() -> MarketoSourcePropertiesTypeDef:
return {
"Object": ...,
}
PutProfileObjectRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import PutProfileObjectRequestRequestTypeDef
def get_value() -> PutProfileObjectRequestRequestTypeDef:
return {
"ObjectTypeName": ...,
"Object": ...,
"DomainName": ...,
}
Definition
class PutProfileObjectRequestRequestTypeDef(TypedDict):
ObjectTypeName: str,
Object: str,
DomainName: str,
S3SourcePropertiesTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import S3SourcePropertiesTypeDef
def get_value() -> S3SourcePropertiesTypeDef:
return {
"BucketName": ...,
}
Definition
class S3SourcePropertiesTypeDef(TypedDict):
BucketName: str,
BucketPrefix: NotRequired[str],
SalesforceSourcePropertiesTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import SalesforceSourcePropertiesTypeDef
def get_value() -> SalesforceSourcePropertiesTypeDef:
return {
"Object": ...,
}
Definition
class SalesforceSourcePropertiesTypeDef(TypedDict):
Object: str,
EnableDynamicFieldUpdate: NotRequired[bool],
IncludeDeletedRecords: NotRequired[bool],
ScheduledTriggerPropertiesTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ScheduledTriggerPropertiesTypeDef
def get_value() -> ScheduledTriggerPropertiesTypeDef:
return {
"ScheduleExpression": ...,
}
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]],
- See DataPullModeType
ServiceNowSourcePropertiesTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ServiceNowSourcePropertiesTypeDef
def get_value() -> ServiceNowSourcePropertiesTypeDef:
return {
"Object": ...,
}
ZendeskSourcePropertiesTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ZendeskSourcePropertiesTypeDef
def get_value() -> ZendeskSourcePropertiesTypeDef:
return {
"Object": ...,
}
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateAddressTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import UpdateAddressTypeDef
def get_value() -> UpdateAddressTypeDef:
return {
"Address1": ...,
}
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
Usage Example
from mypy_boto3_customer_profiles.type_defs import AddProfileKeyResponseTypeDef
def get_value() -> AddProfileKeyResponseTypeDef:
return {
"KeyName": ...,
"Values": ...,
"ResponseMetadata": ...,
}
Definition
class AddProfileKeyResponseTypeDef(TypedDict):
KeyName: str,
Values: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateIntegrationWorkflowResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import CreateIntegrationWorkflowResponseTypeDef
def get_value() -> CreateIntegrationWorkflowResponseTypeDef:
return {
"WorkflowId": ...,
"Message": ...,
"ResponseMetadata": ...,
}
Definition
class CreateIntegrationWorkflowResponseTypeDef(TypedDict):
WorkflowId: str,
Message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProfileResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import CreateProfileResponseTypeDef
def get_value() -> CreateProfileResponseTypeDef:
return {
"ProfileId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateProfileResponseTypeDef(TypedDict):
ProfileId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteDomainResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteDomainResponseTypeDef
def get_value() -> DeleteDomainResponseTypeDef:
return {
"Message": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteDomainResponseTypeDef(TypedDict):
Message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteIntegrationResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteIntegrationResponseTypeDef
def get_value() -> DeleteIntegrationResponseTypeDef:
return {
"Message": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteIntegrationResponseTypeDef(TypedDict):
Message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteProfileKeyResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteProfileKeyResponseTypeDef
def get_value() -> DeleteProfileKeyResponseTypeDef:
return {
"Message": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteProfileKeyResponseTypeDef(TypedDict):
Message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteProfileObjectResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteProfileObjectResponseTypeDef
def get_value() -> DeleteProfileObjectResponseTypeDef:
return {
"Message": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteProfileObjectResponseTypeDef(TypedDict):
Message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteProfileObjectTypeResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteProfileObjectTypeResponseTypeDef
def get_value() -> DeleteProfileObjectTypeResponseTypeDef:
return {
"Message": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteProfileObjectTypeResponseTypeDef(TypedDict):
Message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteProfileResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import DeleteProfileResponseTypeDef
def get_value() -> DeleteProfileResponseTypeDef:
return {
"Message": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteProfileResponseTypeDef(TypedDict):
Message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetAutoMergingPreviewResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetAutoMergingPreviewResponseTypeDef
def get_value() -> GetAutoMergingPreviewResponseTypeDef:
return {
"DomainName": ...,
"NumberOfMatchesInSample": ...,
"NumberOfProfilesInSample": ...,
"NumberOfProfilesWillBeMerged": ...,
"ResponseMetadata": ...,
}
Definition
class GetAutoMergingPreviewResponseTypeDef(TypedDict):
DomainName: str,
NumberOfMatchesInSample: int,
NumberOfProfilesInSample: int,
NumberOfProfilesWillBeMerged: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetIntegrationResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetIntegrationResponseTypeDef
def get_value() -> GetIntegrationResponseTypeDef:
return {
"DomainName": ...,
"Uri": ...,
"ObjectTypeName": ...,
"CreatedAt": ...,
"LastUpdatedAt": ...,
"Tags": ...,
"ObjectTypeNames": ...,
"WorkflowId": ...,
"IsUnstructured": ...,
"ResponseMetadata": ...,
}
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)
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
MergeProfilesResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import MergeProfilesResponseTypeDef
def get_value() -> MergeProfilesResponseTypeDef:
return {
"Message": ...,
"ResponseMetadata": ...,
}
Definition
class MergeProfilesResponseTypeDef(TypedDict):
Message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PutIntegrationResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import PutIntegrationResponseTypeDef
def get_value() -> PutIntegrationResponseTypeDef:
return {
"DomainName": ...,
"Uri": ...,
"ObjectTypeName": ...,
"CreatedAt": ...,
"LastUpdatedAt": ...,
"Tags": ...,
"ObjectTypeNames": ...,
"WorkflowId": ...,
"IsUnstructured": ...,
"ResponseMetadata": ...,
}
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)
PutProfileObjectResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import PutProfileObjectResponseTypeDef
def get_value() -> PutProfileObjectResponseTypeDef:
return {
"ProfileObjectUniqueKey": ...,
"ResponseMetadata": ...,
}
Definition
class PutProfileObjectResponseTypeDef(TypedDict):
ProfileObjectUniqueKey: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateProfileResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import UpdateProfileResponseTypeDef
def get_value() -> UpdateProfileResponseTypeDef:
return {
"ProfileId": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateProfileResponseTypeDef(TypedDict):
ProfileId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SearchProfilesRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import SearchProfilesRequestRequestTypeDef
def get_value() -> SearchProfilesRequestRequestTypeDef:
return {
"DomainName": ...,
"KeyName": ...,
"Values": ...,
}
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)
CreateProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import CreateProfileRequestRequestTypeDef
def get_value() -> CreateProfileRequestRequestTypeDef:
return {
"DomainName": ...,
}
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],
- See PartyTypeType
- See GenderType
- See AddressTypeDef
- See AddressTypeDef
- See AddressTypeDef
- See AddressTypeDef
WorkflowAttributesTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import WorkflowAttributesTypeDef
def get_value() -> WorkflowAttributesTypeDef:
return {
"AppflowIntegration": ...,
}
Definition
class WorkflowAttributesTypeDef(TypedDict):
AppflowIntegration: NotRequired[AppflowIntegrationWorkflowAttributesTypeDef], # (1)
WorkflowMetricsTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import WorkflowMetricsTypeDef
def get_value() -> WorkflowMetricsTypeDef:
return {
"AppflowIntegration": ...,
}
Definition
class WorkflowMetricsTypeDef(TypedDict):
AppflowIntegration: NotRequired[AppflowIntegrationWorkflowMetricsTypeDef], # (1)
WorkflowStepItemTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import WorkflowStepItemTypeDef
def get_value() -> WorkflowStepItemTypeDef:
return {
"AppflowIntegration": ...,
}
Definition
class WorkflowStepItemTypeDef(TypedDict):
AppflowIntegration: NotRequired[AppflowIntegrationWorkflowStepTypeDef], # (1)
AutoMergingTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import AutoMergingTypeDef
def get_value() -> AutoMergingTypeDef:
return {
"Enabled": ...,
}
Definition
class AutoMergingTypeDef(TypedDict):
Enabled: bool,
Consolidation: NotRequired[ConsolidationTypeDef], # (1)
ConflictResolution: NotRequired[ConflictResolutionTypeDef], # (2)
MinAllowedConfidenceScoreForMerging: NotRequired[float],
GetAutoMergingPreviewRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetAutoMergingPreviewRequestRequestTypeDef
def get_value() -> GetAutoMergingPreviewRequestRequestTypeDef:
return {
"DomainName": ...,
"Consolidation": ...,
"ConflictResolution": ...,
}
Definition
class GetAutoMergingPreviewRequestRequestTypeDef(TypedDict):
DomainName: str,
Consolidation: ConsolidationTypeDef, # (1)
ConflictResolution: ConflictResolutionTypeDef, # (2)
MinAllowedConfidenceScoreForMerging: NotRequired[float],
TaskTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import TaskTypeDef
def get_value() -> TaskTypeDef:
return {
"SourceFields": ...,
"TaskType": ...,
}
Definition
class TaskTypeDef(TypedDict):
SourceFields: Sequence[str],
TaskType: TaskTypeType, # (3)
ConnectorOperator: NotRequired[ConnectorOperatorTypeDef], # (1)
DestinationField: NotRequired[str],
TaskProperties: NotRequired[Mapping[OperatorPropertiesKeysType, str]], # (2)
ExportingConfigTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ExportingConfigTypeDef
def get_value() -> ExportingConfigTypeDef:
return {
"S3Exporting": ...,
}
Definition
class ExportingConfigTypeDef(TypedDict):
S3Exporting: NotRequired[S3ExportingConfigTypeDef], # (1)
ExportingLocationTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ExportingLocationTypeDef
def get_value() -> ExportingLocationTypeDef:
return {
"S3Exporting": ...,
}
Definition
class ExportingLocationTypeDef(TypedDict):
S3Exporting: NotRequired[S3ExportingLocationTypeDef], # (1)
MergeProfilesRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import MergeProfilesRequestRequestTypeDef
def get_value() -> MergeProfilesRequestRequestTypeDef:
return {
"DomainName": ...,
"MainProfileId": ...,
"ProfileIdsToBeMerged": ...,
}
Definition
class MergeProfilesRequestRequestTypeDef(TypedDict):
DomainName: str,
MainProfileId: str,
ProfileIdsToBeMerged: Sequence[str],
FieldSourceProfileIds: NotRequired[FieldSourceProfileIdsTypeDef], # (1)
ProfileTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import ProfileTypeDef
def get_value() -> ProfileTypeDef:
return {
"ProfileId": ...,
}
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],
- See PartyTypeType
- See GenderType
- See AddressTypeDef
- See AddressTypeDef
- See AddressTypeDef
- See AddressTypeDef
- See FoundByKeyValueTypeDef
GetMatchesResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetMatchesResponseTypeDef
def get_value() -> GetMatchesResponseTypeDef:
return {
"NextToken": ...,
"MatchGenerationDate": ...,
"PotentialMatches": ...,
"Matches": ...,
"ResponseMetadata": ...,
}
Definition
class GetMatchesResponseTypeDef(TypedDict):
NextToken: str,
MatchGenerationDate: datetime,
PotentialMatches: int,
Matches: List[MatchItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetProfileObjectTypeResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetProfileObjectTypeResponseTypeDef
def get_value() -> GetProfileObjectTypeResponseTypeDef:
return {
"ObjectTypeName": ...,
"Description": ...,
"TemplateId": ...,
"ExpirationDays": ...,
"EncryptionKey": ...,
"AllowProfileCreation": ...,
"SourceLastUpdatedTimestampFormat": ...,
"Fields": ...,
"Keys": ...,
"CreatedAt": ...,
"LastUpdatedAt": ...,
"Tags": ...,
"ResponseMetadata": ...,
}
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)
GetProfileObjectTypeTemplateResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import GetProfileObjectTypeTemplateResponseTypeDef
def get_value() -> GetProfileObjectTypeTemplateResponseTypeDef:
return {
"TemplateId": ...,
"SourceName": ...,
"SourceObject": ...,
"AllowProfileCreation": ...,
"SourceLastUpdatedTimestampFormat": ...,
"Fields": ...,
"Keys": ...,
"ResponseMetadata": ...,
}
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)
PutProfileObjectTypeRequestRequestTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import PutProfileObjectTypeRequestRequestTypeDef
def get_value() -> PutProfileObjectTypeRequestRequestTypeDef:
return {
"DomainName": ...,
"ObjectTypeName": ...,
"Description": ...,
}
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]],
PutProfileObjectTypeResponseTypeDef
Usage Example
from mypy_boto3_customer_profiles.type_defs import PutProfileObjectTypeResponseTypeDef
def get_value() -> PutProfileObjectTypeResponseTypeDef:
return {
"ObjectTypeName": ...,
"Description": ...,
"TemplateId": ...,
"ExpirationDays": ...,
"EncryptionKey": ...,
"AllowProfileCreation": ...,
"SourceLastUpdatedTimestampFormat": ...,
"Fields": ...,
"Keys": ...,
"CreatedAt": ...,
"LastUpdatedAt": ...,
"Tags": ...,
"ResponseMetadata": ...,
}