Module aws_sdk_customerprofiles::types
source · Expand description
Data structures used by operation inputs/outputs.
Modules§
- Builders
- Error types that Amazon Connect Customer Profiles can respond with.
Structs§
A data type pair that consists of a
KeyName
andValues
list that is used in conjunction with the KeyName and Values parameters to search for profiles using the SearchProfiles API.A generic address associated with the customer that is not mailing, shipping, or billing.
Details for workflow of type
APPFLOW_INTEGRATION
.Structure holding all
APPFLOW_INTEGRATION
specific workflow attributes.Workflow specific execution metrics for
APPFLOW_INTEGRATION
workflow.Workflow step details for
APPFLOW_INTEGRATION
workflow.Mathematical expression and a list of attribute items specified in that expression.
The details of a single attribute item specified in the mathematical expression.
Configuration information about the
AttributeTypesSelector
where the rule-based identity resolution uses to match profiles. You can choose how profiles are compared across attribute types and which attribute to use for matching from each type. There are three attribute types you can configure:Configuration settings for how to perform the auto-merging of profiles.
Batch defines the boundaries for ingestion for each step in
APPFLOW_INTEGRATION
workflow.APPFLOW_INTEGRATION
workflow splits ingestion based on these boundaries.The conditions including range, object count, and threshold for the calculated attribute.
How the auto-merging process should resolve conflicts between different profiles.
The operation to be performed on the provided source fields.
The matching criteria to be used during the auto-merging process.
Summary information about the Kinesis data stream
Contains
ProfileObjectType
mapping information from the model.Usage-specific statistics about the domain.
Details of the destination being used for the EventStream.
An instance of EventStream in a list of EventStreams.
Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.
The S3 location where Identity Resolution Jobs write result files.
A duplicate customer profile that is to be merged into a main profile.
The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of customers.
A data type pair that consists of a
KeyName
andValues
list that were used to find a profile returned in response to a SearchProfiles request.Information about the Identity Resolution Job.
Specifies the configuration used when importing incremental records from the source.
Configuration data for integration workflow.
The day and time when do you want to start the Identity Resolution Job every week.
Statistics about the Identity Resolution Job.
The details of a single calculated attribute definition.
The details of a single calculated attribute for a profile.
An object in a list that represents a domain.
An integration in list of integrations.
A ProfileObjectType instance.
A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.
A ProfileObject in a list of ProfileObjects.
A workflow in list of workflows.
The properties that are applied when Marketo is being used as a source.
The Match group object.
The flag that enables the matching process of duplicate profiles.
The flag that enables the matching process of duplicate profiles.
Specifies how does the rule-based matching process should match profiles. You can choose from the following attributes to build the matching Rule:
The filter applied to
ListProfileObjects
response to include profile objects with the specified index values.Represents a field in a ProfileObjectType.
An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.
The standard profile of a customer.
The relative time period over which data is included in the aggregation.
The request to enable the rule-based matching.
The response of the Rule-based matching request.
Configuration information about the S3 bucket where Identity Resolution Jobs write result files.
The S3 location where Identity Resolution Jobs write result files.
The properties that are applied when Amazon S3 is being used as the flow source.
The properties that are applied when Salesforce is being used as a source.
Specifies the configuration details of a scheduled-trigger flow that you define. Currently, these settings only apply to the scheduled-trigger type.
The properties that are applied when ServiceNow is being used as a source.
Specifies the information that is required to query a particular Amazon AppFlow connector. Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.
Contains information about the configuration of the source connector used in the flow.
A class for modeling different type of tasks. Task implementation varies based on the TaskType.
The threshold for the calculated attribute.
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
Specifies the configuration details that control the trigger for a flow. Currently, these settings only apply to the Scheduled trigger type.
Updates associated with the address properties of a customer profile.
Structure to hold workflow attributes.
Generic object containing workflow execution metrics.
List containing steps in workflow.
The properties that are applied when using Zendesk as a flow source.
Enums§
- When writing a match expression against
AttributeMatchingModel
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ConflictResolvingModel
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
DataPullMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
EventStreamDestinationStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
EventStreamState
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
FieldContentType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - GenderDeprecatedWhen writing a match expression against
Gender
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
IdentityResolutionJobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
JobScheduleDayOfTheWeek
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
LogicalOperator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
MarketoConnectorOperator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
MatchType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
Operator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
OperatorPropertiesKeys
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - PartyTypeDeprecatedWhen writing a match expression against
PartyType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
RuleBasedMatchingStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
S3ConnectorOperator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
SalesforceConnectorOperator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ServiceNowConnectorOperator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
SourceConnectorType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
StandardIdentifier
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
Statistic
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
Status
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
TaskType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
TriggerType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
Unit
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
WorkflowType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - When writing a match expression against
ZendeskConnectorOperator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.