2021/03/26 - Amazon Connect Customer Profiles - 1 updated api methods
Changes This release adds an optional parameter named FlowDefinition in PutIntegrationRequest.
{'FlowDefinition': {'Description': 'string',
'FlowName': 'string',
'KmsArn': 'string',
'SourceFlowConfig': {'ConnectorProfileName': 'string',
'ConnectorType': 'Salesforce | '
'Marketo | Zendesk | '
'Servicenow | S3',
'IncrementalPullConfig': {'DatetimeTypeFieldName': 'string'},
'SourceConnectorProperties': {'Marketo': {'Object': 'string'},
'S3': {'BucketName': 'string',
'BucketPrefix': 'string'},
'Salesforce': {'EnableDynamicFieldUpdate': 'boolean',
'IncludeDeletedRecords': 'boolean',
'Object': 'string'},
'ServiceNow': {'Object': 'string'},
'Zendesk': {'Object': 'string'}}},
'Tasks': [{'ConnectorOperator': {'Marketo': 'PROJECTION | '
'LESS_THAN | '
'GREATER_THAN '
'| BETWEEN | '
'ADDITION | '
'MULTIPLICATION '
'| DIVISION | '
'SUBTRACTION | '
'MASK_ALL | '
'MASK_FIRST_N '
'| MASK_LAST_N '
'| '
'VALIDATE_NON_NULL '
'| '
'VALIDATE_NON_ZERO '
'| '
'VALIDATE_NON_NEGATIVE '
'| '
'VALIDATE_NUMERIC '
'| NO_OP',
'S3': 'PROJECTION | '
'LESS_THAN | '
'GREATER_THAN | '
'BETWEEN | '
'LESS_THAN_OR_EQUAL_TO '
'| '
'GREATER_THAN_OR_EQUAL_TO '
'| EQUAL_TO | '
'NOT_EQUAL_TO | '
'ADDITION | '
'MULTIPLICATION | '
'DIVISION | '
'SUBTRACTION | '
'MASK_ALL | '
'MASK_FIRST_N | '
'MASK_LAST_N | '
'VALIDATE_NON_NULL '
'| '
'VALIDATE_NON_ZERO '
'| '
'VALIDATE_NON_NEGATIVE '
'| VALIDATE_NUMERIC '
'| NO_OP',
'Salesforce': 'PROJECTION '
'| '
'LESS_THAN '
'| CONTAINS '
'| '
'GREATER_THAN '
'| BETWEEN '
'| '
'LESS_THAN_OR_EQUAL_TO '
'| '
'GREATER_THAN_OR_EQUAL_TO '
'| EQUAL_TO '
'| '
'NOT_EQUAL_TO '
'| ADDITION '
'| '
'MULTIPLICATION '
'| DIVISION '
'| '
'SUBTRACTION '
'| MASK_ALL '
'| '
'MASK_FIRST_N '
'| '
'MASK_LAST_N '
'| '
'VALIDATE_NON_NULL '
'| '
'VALIDATE_NON_ZERO '
'| '
'VALIDATE_NON_NEGATIVE '
'| '
'VALIDATE_NUMERIC '
'| NO_OP',
'ServiceNow': 'PROJECTION '
'| CONTAINS '
'| '
'LESS_THAN '
'| '
'GREATER_THAN '
'| BETWEEN '
'| '
'LESS_THAN_OR_EQUAL_TO '
'| '
'GREATER_THAN_OR_EQUAL_TO '
'| EQUAL_TO '
'| '
'NOT_EQUAL_TO '
'| ADDITION '
'| '
'MULTIPLICATION '
'| DIVISION '
'| '
'SUBTRACTION '
'| MASK_ALL '
'| '
'MASK_FIRST_N '
'| '
'MASK_LAST_N '
'| '
'VALIDATE_NON_NULL '
'| '
'VALIDATE_NON_ZERO '
'| '
'VALIDATE_NON_NEGATIVE '
'| '
'VALIDATE_NUMERIC '
'| NO_OP',
'Zendesk': 'PROJECTION | '
'GREATER_THAN '
'| ADDITION | '
'MULTIPLICATION '
'| DIVISION | '
'SUBTRACTION | '
'MASK_ALL | '
'MASK_FIRST_N '
'| MASK_LAST_N '
'| '
'VALIDATE_NON_NULL '
'| '
'VALIDATE_NON_ZERO '
'| '
'VALIDATE_NON_NEGATIVE '
'| '
'VALIDATE_NUMERIC '
'| NO_OP'},
'DestinationField': 'string',
'SourceFields': ['string'],
'TaskProperties': {'VALUE | VALUES | DATA_TYPE | UPPER_BOUND | LOWER_BOUND | SOURCE_DATA_TYPE | DESTINATION_DATA_TYPE | VALIDATION_ACTION | MASK_VALUE | MASK_LENGTH | TRUNCATE_LENGTH | MATH_OPERATION_FIELDS_ORDER | CONCAT_FORMAT | SUBFIELD_CATEGORY_MAP': 'string'},
'TaskType': 'Arithmetic | Filter | Map | Mask | '
'Merge | Truncate | Validate'}],
'TriggerConfig': {'TriggerProperties': {'Scheduled': {'DataPullMode': 'Incremental '
'| '
'Complete',
'FirstExecutionFrom': 'timestamp',
'ScheduleEndTime': 'timestamp',
'ScheduleExpression': 'string',
'ScheduleOffset': 'long',
'ScheduleStartTime': 'timestamp',
'Timezone': 'string'}},
'TriggerType': 'Scheduled | Event | '
'OnDemand'}}}
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
An integration can belong to only one domain.
See also: AWS API Documentation
Request Syntax
client.put_integration(
DomainName='string',
Uri='string',
ObjectTypeName='string',
Tags={
'string': 'string'
},
FlowDefinition={
'Description': 'string',
'FlowName': 'string',
'KmsArn': 'string',
'SourceFlowConfig': {
'ConnectorProfileName': 'string',
'ConnectorType': 'Salesforce'|'Marketo'|'Zendesk'|'Servicenow'|'S3',
'IncrementalPullConfig': {
'DatetimeTypeFieldName': 'string'
},
'SourceConnectorProperties': {
'Marketo': {
'Object': 'string'
},
'S3': {
'BucketName': 'string',
'BucketPrefix': 'string'
},
'Salesforce': {
'Object': 'string',
'EnableDynamicFieldUpdate': True|False,
'IncludeDeletedRecords': True|False
},
'ServiceNow': {
'Object': 'string'
},
'Zendesk': {
'Object': 'string'
}
}
},
'Tasks': [
{
'ConnectorOperator': {
'Marketo': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'S3': 'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'Salesforce': 'PROJECTION'|'LESS_THAN'|'CONTAINS'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'ServiceNow': 'PROJECTION'|'CONTAINS'|'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
'Zendesk': 'PROJECTION'|'GREATER_THAN'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP'
},
'DestinationField': 'string',
'SourceFields': [
'string',
],
'TaskProperties': {
'string': 'string'
},
'TaskType': 'Arithmetic'|'Filter'|'Map'|'Mask'|'Merge'|'Truncate'|'Validate'
},
],
'TriggerConfig': {
'TriggerType': 'Scheduled'|'Event'|'OnDemand',
'TriggerProperties': {
'Scheduled': {
'ScheduleExpression': 'string',
'DataPullMode': 'Incremental'|'Complete',
'ScheduleStartTime': datetime(2015, 1, 1),
'ScheduleEndTime': datetime(2015, 1, 1),
'Timezone': 'string',
'ScheduleOffset': 123,
'FirstExecutionFrom': datetime(2015, 1, 1)
}
}
}
}
)
string
[REQUIRED]
The unique name of the domain.
string
The URI of the S3 bucket or any other type of data source.
string
[REQUIRED]
The name of the profile object type.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Description (string) --
FlowName (string) -- [REQUIRED]
KmsArn (string) -- [REQUIRED]
SourceFlowConfig (dict) -- [REQUIRED]
ConnectorProfileName (string) --
ConnectorType (string) -- [REQUIRED]
IncrementalPullConfig (dict) --
DatetimeTypeFieldName (string) --
SourceConnectorProperties (dict) -- [REQUIRED]
Marketo (dict) --
Object (string) -- [REQUIRED]
S3 (dict) --
BucketName (string) -- [REQUIRED]
BucketPrefix (string) --
Salesforce (dict) --
Object (string) -- [REQUIRED]
EnableDynamicFieldUpdate (boolean) --
IncludeDeletedRecords (boolean) --
ServiceNow (dict) --
Object (string) -- [REQUIRED]
Zendesk (dict) --
Object (string) -- [REQUIRED]
Tasks (list) -- [REQUIRED]
(dict) --
ConnectorOperator (dict) --
Marketo (string) --
S3 (string) --
Salesforce (string) --
ServiceNow (string) --
Zendesk (string) --
DestinationField (string) --
SourceFields (list) -- [REQUIRED]
(string) --
TaskProperties (dict) --
(string) --
(string) --
TaskType (string) -- [REQUIRED]
TriggerConfig (dict) -- [REQUIRED]
TriggerType (string) -- [REQUIRED]
TriggerProperties (dict) --
Scheduled (dict) --
ScheduleExpression (string) -- [REQUIRED]
DataPullMode (string) --
ScheduleStartTime (datetime) --
ScheduleEndTime (datetime) --
Timezone (string) --
ScheduleOffset (integer) --
FirstExecutionFrom (datetime) --
dict
Response Syntax
{
'DomainName': 'string',
'Uri': 'string',
'ObjectTypeName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
Uri (string) --
The URI of the S3 bucket or any other type of data source.
ObjectTypeName (string) --
The name of the profile object type.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --