Documentation ¶
Index ¶
- type AccessDeniedException
- type AdditionalSearchKey
- type Address
- type AppflowIntegration
- type AppflowIntegrationWorkflowAttributes
- type AppflowIntegrationWorkflowMetrics
- type AppflowIntegrationWorkflowStep
- type AttributeDetails
- type AttributeItem
- type AttributeMatchingModel
- type AttributeTypesSelector
- type AutoMerging
- type BadRequestException
- type Batch
- type Conditions
- type ConflictResolution
- type ConflictResolvingModel
- type ConnectorOperator
- type Consolidation
- type DataPullMode
- type DestinationSummary
- type DetectedProfileObjectType
- type DomainStats
- type EventStreamDestinationDetails
- type EventStreamDestinationStatus
- type EventStreamState
- type EventStreamSummary
- type ExportingConfig
- type ExportingLocation
- type FieldContentType
- type FieldSourceProfileIds
- type FlowDefinition
- type FoundByKeyValue
- type Gender
- type IdentityResolutionJob
- type IdentityResolutionJobStatus
- type IncrementalPullConfig
- type IntegrationConfig
- type InternalServerException
- type JobSchedule
- type JobScheduleDayOfTheWeek
- type JobStats
- type ListCalculatedAttributeDefinitionItem
- type ListCalculatedAttributeForProfileItem
- type ListDomainItem
- type ListIntegrationItem
- type ListProfileObjectTypeItem
- type ListProfileObjectTypeTemplateItem
- type ListProfileObjectsItem
- type ListWorkflowsItem
- type LogicalOperator
- type MarketoConnectorOperator
- type MarketoSourceProperties
- type MatchItem
- type MatchType
- type MatchingRequest
- type MatchingResponse
- type MatchingRule
- type ObjectFilter
- type ObjectTypeField
- type ObjectTypeKey
- type Operator
- type OperatorPropertiesKeys
- type PartyType
- type Profile
- type Range
- type ResourceNotFoundException
- type RuleBasedMatchingRequest
- type RuleBasedMatchingResponse
- type RuleBasedMatchingStatus
- type S3ConnectorOperator
- type S3ExportingConfig
- type S3ExportingLocation
- type S3SourceProperties
- type SalesforceConnectorOperator
- type SalesforceSourceProperties
- type ScheduledTriggerProperties
- type ServiceNowConnectorOperator
- type ServiceNowSourceProperties
- type SourceConnectorProperties
- type SourceConnectorType
- type SourceFlowConfig
- type StandardIdentifier
- type Statistic
- type Status
- type Task
- type TaskType
- type Threshold
- type ThrottlingException
- type TriggerConfig
- type TriggerProperties
- type TriggerType
- type Unit
- type UpdateAddress
- type WorkflowAttributes
- type WorkflowMetrics
- type WorkflowStepItem
- type WorkflowType
- type ZendeskConnectorOperator
- type ZendeskSourceProperties
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
You do not have sufficient access to perform this action.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type AdditionalSearchKey ¶
type AdditionalSearchKey struct { // A searchable identifier of a customer profile. // // This member is required. KeyName *string // A list of key values. // // This member is required. Values []string // contains filtered or unexported fields }
A data type pair that consists of a KeyName and Values list that is used in conjunction with the KeyNameand Values parameters to search for profiles using the SearchProfiles API.
type Address ¶
type Address struct { // The first line of a customer address. Address1 *string // The second line of a customer address. Address2 *string // The third line of a customer address. Address3 *string // The fourth line of a customer address. Address4 *string // The city in which a customer lives. City *string // The country in which a customer lives. Country *string // The county in which a customer lives. County *string // The postal code of a customer address. PostalCode *string // The province in which a customer lives. Province *string // The state in which a customer lives. State *string // contains filtered or unexported fields }
A generic address associated with the customer that is not mailing, shipping, or billing.
type AppflowIntegration ¶
type AppflowIntegration struct { // 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. // // This member is required. FlowDefinition *FlowDefinition // Batches in workflow of type APPFLOW_INTEGRATION . Batches []Batch // contains filtered or unexported fields }
Details for workflow of type APPFLOW_INTEGRATION .
type AppflowIntegrationWorkflowAttributes ¶
type AppflowIntegrationWorkflowAttributes struct { // The name of the AppFlow connector profile used for ingestion. // // This member is required. ConnectorProfileName *string // Specifies the source connector type, such as Salesforce, ServiceNow, and // Marketo. Indicates source of ingestion. // // This member is required. SourceConnectorType SourceConnectorType // The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this // role to create resources on your behalf as part of workflow execution. RoleArn *string // contains filtered or unexported fields }
Structure holding all APPFLOW_INTEGRATION specific workflow attributes.
type AppflowIntegrationWorkflowMetrics ¶
type AppflowIntegrationWorkflowMetrics struct { // Number of records processed in APPFLOW_INTEGRATION workflow. // // This member is required. RecordsProcessed int64 // Total steps completed in APPFLOW_INTEGRATION workflow. // // This member is required. StepsCompleted int64 // Total steps in APPFLOW_INTEGRATION workflow. // // This member is required. TotalSteps int64 // contains filtered or unexported fields }
Workflow specific execution metrics for APPFLOW_INTEGRATION workflow.
type AppflowIntegrationWorkflowStep ¶
type AppflowIntegrationWorkflowStep struct { // End datetime of records pulled in batch during execution of workflow step for // APPFLOW_INTEGRATION workflow. // // This member is required. BatchRecordsEndTime *string // Start datetime of records pulled in batch during execution of workflow step for // APPFLOW_INTEGRATION workflow. // // This member is required. BatchRecordsStartTime *string // Creation timestamp of workflow step for APPFLOW_INTEGRATION workflow. // // This member is required. CreatedAt *time.Time // Message indicating execution of workflow step for APPFLOW_INTEGRATION workflow. // // This member is required. ExecutionMessage *string // Name of the flow created during execution of workflow step. APPFLOW_INTEGRATION // workflow type creates an appflow flow during workflow step execution on the // customers behalf. // // This member is required. FlowName *string // Last updated timestamp for workflow step for APPFLOW_INTEGRATION workflow. // // This member is required. LastUpdatedAt *time.Time // Total number of records processed during execution of workflow step for // APPFLOW_INTEGRATION workflow. // // This member is required. RecordsProcessed int64 // Workflow step status for APPFLOW_INTEGRATION workflow. // // This member is required. Status Status // contains filtered or unexported fields }
Workflow step details for APPFLOW_INTEGRATION workflow.
type AttributeDetails ¶
type AttributeDetails struct { // A list of attribute items specified in the mathematical expression. // // This member is required. Attributes []AttributeItem // Mathematical expression that is performed on attribute items provided in the // attribute list. Each element in the expression should follow the structure of // \"{ObjectTypeName.AttributeName}\". // // This member is required. Expression *string // contains filtered or unexported fields }
Mathematical expression and a list of attribute items specified in that expression.
type AttributeItem ¶
type AttributeItem struct { // The name of an attribute defined in a profile object type. // // This member is required. Name *string // contains filtered or unexported fields }
The details of a single attribute item specified in the mathematical expression.
type AttributeMatchingModel ¶
type AttributeMatchingModel string
const ( AttributeMatchingModelOneToOne AttributeMatchingModel = "ONE_TO_ONE" AttributeMatchingModelManyToMany AttributeMatchingModel = "MANY_TO_MANY" )
Enum values for AttributeMatchingModel
func (AttributeMatchingModel) Values ¶
func (AttributeMatchingModel) Values() []AttributeMatchingModel
Values returns all known values for AttributeMatchingModel. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type AttributeTypesSelector ¶
type AttributeTypesSelector struct { // Configures the AttributeMatchingModel , you can either choose ONE_TO_ONE or // MANY_TO_MANY . // // This member is required. AttributeMatchingModel AttributeMatchingModel // The Address type. You can choose from Address , BusinessAddress , // MaillingAddress , and ShippingAddress . // // You only can use the Address type in the MatchingRule . For example, if you want // to match profile based on BusinessAddress.City or MaillingAddress.City , you // need to choose the BusinessAddress and the MaillingAddress to represent the // Address type and specify the Address.City on the matching rule. Address []string // The Email type. You can choose from EmailAddress , BusinessEmailAddress and // PersonalEmailAddress . // // You only can use the EmailAddress type in the MatchingRule . For example, if you // want to match profile based on PersonalEmailAddress or BusinessEmailAddress , // you need to choose the PersonalEmailAddress and the BusinessEmailAddress to // represent the EmailAddress type and only specify the EmailAddress on the // matching rule. EmailAddress []string // The PhoneNumber type. You can choose from PhoneNumber , HomePhoneNumber , and // MobilePhoneNumber . // // You only can use the PhoneNumber type in the MatchingRule . For example, if you // want to match a profile based on Phone or HomePhone , you need to choose the // Phone and the HomePhone to represent the PhoneNumber type and only specify the // PhoneNumber on the matching rule. PhoneNumber []string // contains filtered or unexported fields }
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:
Email type
You can choose from Email , BusinessEmail , and PersonalEmail
Phone number type
You can choose from Phone , HomePhone , and MobilePhone
Address type
You can choose from Address , BusinessAddress , MaillingAddress , and ShippingAddress
You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel . When choosing MANY_TO_MANY , the system can match attribute across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the two profiles are matched on the Email type.
type AutoMerging ¶
type AutoMerging struct { // The flag that enables the auto-merging of duplicate profiles. // // This member is required. Enabled *bool // How the auto-merging process should resolve conflicts between different // profiles. For example, if Profile A and Profile B have the same FirstName and // LastName (and that is the matching criteria), which EmailAddress should be // used? ConflictResolution *ConflictResolution // A list of matching attributes that represent matching criteria. If two profiles // meet at least one of the requirements in the matching attributes list, they will // be merged. Consolidation *Consolidation // A number between 0 and 1 that represents the minimum confidence score required // for profiles within a matching group to be merged during the auto-merge process. // A higher score means higher similarity required to merge profiles. MinAllowedConfidenceScoreForMerging *float64 // contains filtered or unexported fields }
Configuration settings for how to perform the auto-merging of profiles.
type BadRequestException ¶
type BadRequestException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The input you provided is invalid.
func (*BadRequestException) Error ¶
func (e *BadRequestException) Error() string
func (*BadRequestException) ErrorCode ¶
func (e *BadRequestException) ErrorCode() string
func (*BadRequestException) ErrorFault ¶
func (e *BadRequestException) ErrorFault() smithy.ErrorFault
func (*BadRequestException) ErrorMessage ¶
func (e *BadRequestException) ErrorMessage() string
type Batch ¶
type Batch struct { // End time of batch to split ingestion. // // This member is required. EndTime *time.Time // Start time of batch to split ingestion. // // This member is required. StartTime *time.Time // contains filtered or unexported fields }
Batch defines the boundaries for ingestion for each step in APPFLOW_INTEGRATION workflow. APPFLOW_INTEGRATION workflow splits ingestion based on these boundaries.
type Conditions ¶
type Conditions struct { // The number of profile objects used for the calculated attribute. ObjectCount *int32 // The relative time period over which data is included in the aggregation. Range *Range // The threshold for the calculated attribute. Threshold *Threshold // contains filtered or unexported fields }
The conditions including range, object count, and threshold for the calculated attribute.
type ConflictResolution ¶
type ConflictResolution struct { // How the auto-merging process should resolve conflicts between different // profiles. // // - RECENCY : Uses the data that was most recently updated. // // - SOURCE : Uses the data from a specific source. For example, if a company has // been aquired or two departments have merged, data from the specified source is // used. If two duplicate profiles are from the same source, then RECENCY is used // again. // // This member is required. ConflictResolvingModel ConflictResolvingModel // The ObjectType name that is used to resolve profile merging conflicts when // choosing SOURCE as the ConflictResolvingModel . SourceName *string // contains filtered or unexported fields }
How the auto-merging process should resolve conflicts between different profiles.
type ConflictResolvingModel ¶
type ConflictResolvingModel string
const ( ConflictResolvingModelRecency ConflictResolvingModel = "RECENCY" ConflictResolvingModelSource ConflictResolvingModel = "SOURCE" )
Enum values for ConflictResolvingModel
func (ConflictResolvingModel) Values ¶
func (ConflictResolvingModel) Values() []ConflictResolvingModel
Values returns all known values for ConflictResolvingModel. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ConnectorOperator ¶
type ConnectorOperator struct { // The operation to be performed on the provided Marketo source fields. Marketo MarketoConnectorOperator // The operation to be performed on the provided Amazon S3 source fields. S3 S3ConnectorOperator // The operation to be performed on the provided Salesforce source fields. Salesforce SalesforceConnectorOperator // The operation to be performed on the provided ServiceNow source fields. ServiceNow ServiceNowConnectorOperator // The operation to be performed on the provided Zendesk source fields. Zendesk ZendeskConnectorOperator // contains filtered or unexported fields }
The operation to be performed on the provided source fields.
type Consolidation ¶
type Consolidation struct { // A list of matching criteria. // // This member is required. MatchingAttributesList [][]string // contains filtered or unexported fields }
The matching criteria to be used during the auto-merging process.
type DataPullMode ¶
type DataPullMode string
const ( DataPullModeIncremental DataPullMode = "Incremental" DataPullModeComplete DataPullMode = "Complete" )
Enum values for DataPullMode
func (DataPullMode) Values ¶
func (DataPullMode) Values() []DataPullMode
Values returns all known values for DataPullMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DestinationSummary ¶
type DestinationSummary struct { // The status of enabling the Kinesis stream as a destination for export. // // This member is required. Status EventStreamDestinationStatus // The StreamARN of the destination to deliver profile events to. For example, // arn:aws:kinesis:region:account-id:stream/stream-name. // // This member is required. Uri *string // The timestamp when the status last changed to UNHEALHY . UnhealthySince *time.Time // contains filtered or unexported fields }
Summary information about the Kinesis data stream
type DetectedProfileObjectType ¶
type DetectedProfileObjectType struct { // A map of the name and the ObjectType field. Fields map[string]ObjectTypeField // A list of unique keys that can be used to map data to a profile. Keys map[string][]ObjectTypeKey // The format of sourceLastUpdatedTimestamp that was detected in fields. SourceLastUpdatedTimestampFormat *string // contains filtered or unexported fields }
Contains ProfileObjectType mapping information from the model.
type DomainStats ¶
type DomainStats struct { // The number of profiles that you are currently paying for in the domain. If you // have more than 100 objects associated with a single profile, that profile counts // as two profiles. If you have more than 200 objects, that profile counts as // three, and so on. MeteringProfileCount int64 // The total number of objects in domain. ObjectCount int64 // The total number of profiles currently in the domain. ProfileCount int64 // The total size, in bytes, of all objects in the domain. TotalSize int64 // contains filtered or unexported fields }
Usage-specific statistics about the domain.
type EventStreamDestinationDetails ¶
type EventStreamDestinationDetails struct { // The status of enabling the Kinesis stream as a destination for export. // // This member is required. Status EventStreamDestinationStatus // The StreamARN of the destination to deliver profile events to. For example, // arn:aws:kinesis:region:account-id:stream/stream-name. // // This member is required. Uri *string // The human-readable string that corresponds to the error or success while // enabling the streaming destination. Message *string // The timestamp when the status last changed to UNHEALHY . UnhealthySince *time.Time // contains filtered or unexported fields }
Details of the destination being used for the EventStream.
type EventStreamDestinationStatus ¶
type EventStreamDestinationStatus string
const ( EventStreamDestinationStatusHealthy EventStreamDestinationStatus = "HEALTHY" EventStreamDestinationStatusUnhealthy EventStreamDestinationStatus = "UNHEALTHY" )
Enum values for EventStreamDestinationStatus
func (EventStreamDestinationStatus) Values ¶
func (EventStreamDestinationStatus) Values() []EventStreamDestinationStatus
Values returns all known values for EventStreamDestinationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EventStreamState ¶
type EventStreamState string
const ( EventStreamStateRunning EventStreamState = "RUNNING" EventStreamStateStopped EventStreamState = "STOPPED" )
Enum values for EventStreamState
func (EventStreamState) Values ¶
func (EventStreamState) Values() []EventStreamState
Values returns all known values for EventStreamState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EventStreamSummary ¶
type EventStreamSummary struct { // The unique name of the domain. // // This member is required. DomainName *string // A unique identifier for the event stream. // // This member is required. EventStreamArn *string // The name of the event stream. // // This member is required. EventStreamName *string // The operational state of destination stream for export. // // This member is required. State EventStreamState // Summary information about the Kinesis data stream. DestinationSummary *DestinationSummary // The timestamp when the State changed to STOPPED . StoppedSince *time.Time // The tags used to organize, track, or control access for this resource. Tags map[string]string // contains filtered or unexported fields }
An instance of EventStream in a list of EventStreams.
type ExportingConfig ¶
type ExportingConfig struct { // The S3 location where Identity Resolution Jobs write result files. S3Exporting *S3ExportingConfig // contains filtered or unexported fields }
Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.
You need to give Customer Profiles service principal write permission to your S3 bucket. Otherwise, you'll get an exception in the API response. For an example policy, see Amazon Connect Customer Profiles cross-service confused deputy prevention.
type ExportingLocation ¶
type ExportingLocation struct { // Information about the S3 location where Identity Resolution Jobs write result // files. S3Exporting *S3ExportingLocation // contains filtered or unexported fields }
The S3 location where Identity Resolution Jobs write result files.
type FieldContentType ¶
type FieldContentType string
const ( FieldContentTypeString FieldContentType = "STRING" FieldContentTypeNumber FieldContentType = "NUMBER" FieldContentTypePhoneNumber FieldContentType = "PHONE_NUMBER" FieldContentTypeEmailAddress FieldContentType = "EMAIL_ADDRESS" FieldContentTypeName FieldContentType = "NAME" )
Enum values for FieldContentType
func (FieldContentType) Values ¶
func (FieldContentType) Values() []FieldContentType
Values returns all known values for FieldContentType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type FieldSourceProfileIds ¶
type FieldSourceProfileIds struct { // A unique identifier for the account number field to be merged. AccountNumber *string // A unique identifier for the additional information field to be merged. AdditionalInformation *string // A unique identifier for the party type field to be merged. Address *string // A unique identifier for the attributes field to be merged. Attributes map[string]string // A unique identifier for the billing type field to be merged. BillingAddress *string // A unique identifier for the birthdate field to be merged. BirthDate *string // A unique identifier for the party type field to be merged. BusinessEmailAddress *string // A unique identifier for the business name field to be merged. BusinessName *string // A unique identifier for the business phone number field to be merged. BusinessPhoneNumber *string // A unique identifier for the email address field to be merged. EmailAddress *string // A unique identifier for the first name field to be merged. FirstName *string // A unique identifier for the gender field to be merged. Gender *string // A unique identifier for the home phone number field to be merged. HomePhoneNumber *string // A unique identifier for the last name field to be merged. LastName *string // A unique identifier for the mailing address field to be merged. MailingAddress *string // A unique identifier for the middle name field to be merged. MiddleName *string // A unique identifier for the mobile phone number field to be merged. MobilePhoneNumber *string // A unique identifier for the party type field to be merged. PartyType *string // A unique identifier for the personal email address field to be merged. PersonalEmailAddress *string // A unique identifier for the phone number field to be merged. PhoneNumber *string // A unique identifier for the shipping address field to be merged. ShippingAddress *string // contains filtered or unexported fields }
A duplicate customer profile that is to be merged into a main profile.
type FlowDefinition ¶
type FlowDefinition struct { // The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces // are not allowed. // // This member is required. FlowName *string // The Amazon Resource Name of the AWS Key Management Service (KMS) key you // provide for encryption. // // This member is required. KmsArn *string // The configuration that controls how Customer Profiles retrieves data from the // source. // // This member is required. SourceFlowConfig *SourceFlowConfig // A list of tasks that Customer Profiles performs while transferring the data in // the flow run. // // This member is required. Tasks []Task // The trigger settings that determine how and when the flow runs. // // This member is required. TriggerConfig *TriggerConfig // A description of the flow you want to create. Description *string // contains filtered or unexported fields }
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.
type FoundByKeyValue ¶
type FoundByKeyValue struct { // A searchable identifier of a customer profile. KeyName *string // A list of key values. Values []string // contains filtered or unexported fields }
A data type pair that consists of a KeyName and Values list that were used to find a profile returned in response to a SearchProfilesrequest.
type Gender ¶
type Gender string
type IdentityResolutionJob ¶
type IdentityResolutionJob struct { // The unique name of the domain. DomainName *string // The S3 location where the Identity Resolution Job writes result files. ExportingLocation *ExportingLocation // The timestamp of when the job was completed. JobEndTime *time.Time // The unique identifier of the Identity Resolution Job. JobId *string // The timestamp of when the job was started or will be started. JobStartTime *time.Time // Statistics about an Identity Resolution Job. JobStats *JobStats // The error messages that are generated when the Identity Resolution Job runs. Message *string // The status of the Identity Resolution Job. // // - PENDING : The Identity Resolution Job is scheduled but has not started yet. // If you turn off the Identity Resolution feature in your domain, jobs in the // PENDING state are deleted. // // - PREPROCESSING : The Identity Resolution Job is loading your data. // // - FIND_MATCHING : The Identity Resolution Job is using the machine learning // model to identify profiles that belong to the same matching group. // // - MERGING : The Identity Resolution Job is merging duplicate profiles. // // - COMPLETED : The Identity Resolution Job completed successfully. // // - PARTIAL_SUCCESS : There's a system error and not all of the data is merged. // The Identity Resolution Job writes a message indicating the source of the // problem. // // - FAILED : The Identity Resolution Job did not merge any data. It writes a // message indicating the source of the problem. Status IdentityResolutionJobStatus // contains filtered or unexported fields }
Information about the Identity Resolution Job.
type IdentityResolutionJobStatus ¶
type IdentityResolutionJobStatus string
const ( IdentityResolutionJobStatusPending IdentityResolutionJobStatus = "PENDING" IdentityResolutionJobStatusPreprocessing IdentityResolutionJobStatus = "PREPROCESSING" IdentityResolutionJobStatusFindMatching IdentityResolutionJobStatus = "FIND_MATCHING" IdentityResolutionJobStatusMerging IdentityResolutionJobStatus = "MERGING" IdentityResolutionJobStatusCompleted IdentityResolutionJobStatus = "COMPLETED" IdentityResolutionJobStatusPartialSuccess IdentityResolutionJobStatus = "PARTIAL_SUCCESS" IdentityResolutionJobStatusFailed IdentityResolutionJobStatus = "FAILED" )
Enum values for IdentityResolutionJobStatus
func (IdentityResolutionJobStatus) Values ¶
func (IdentityResolutionJobStatus) Values() []IdentityResolutionJobStatus
Values returns all known values for IdentityResolutionJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type IncrementalPullConfig ¶
type IncrementalPullConfig struct { // A field that specifies the date time or timestamp field as the criteria to use // when importing incremental records from the source. DatetimeTypeFieldName *string // contains filtered or unexported fields }
Specifies the configuration used when importing incremental records from the source.
type IntegrationConfig ¶
type IntegrationConfig struct { // Configuration data for APPFLOW_INTEGRATION workflow type. AppflowIntegration *AppflowIntegration // contains filtered or unexported fields }
Configuration data for integration workflow.
type InternalServerException ¶
type InternalServerException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
An internal service error occurred.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type JobSchedule ¶
type JobSchedule struct { // The day when the Identity Resolution Job should run every week. // // This member is required. DayOfTheWeek JobScheduleDayOfTheWeek // The time when the Identity Resolution Job should run every week. // // This member is required. Time *string // contains filtered or unexported fields }
The day and time when do you want to start the Identity Resolution Job every week.
type JobScheduleDayOfTheWeek ¶
type JobScheduleDayOfTheWeek string
const ( JobScheduleDayOfTheWeekSunday JobScheduleDayOfTheWeek = "SUNDAY" JobScheduleDayOfTheWeekMonday JobScheduleDayOfTheWeek = "MONDAY" JobScheduleDayOfTheWeekTuesday JobScheduleDayOfTheWeek = "TUESDAY" JobScheduleDayOfTheWeekWednesday JobScheduleDayOfTheWeek = "WEDNESDAY" JobScheduleDayOfTheWeekThursday JobScheduleDayOfTheWeek = "THURSDAY" JobScheduleDayOfTheWeekFriday JobScheduleDayOfTheWeek = "FRIDAY" JobScheduleDayOfTheWeekSaturday JobScheduleDayOfTheWeek = "SATURDAY" )
Enum values for JobScheduleDayOfTheWeek
func (JobScheduleDayOfTheWeek) Values ¶
func (JobScheduleDayOfTheWeek) Values() []JobScheduleDayOfTheWeek
Values returns all known values for JobScheduleDayOfTheWeek. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type JobStats ¶
type JobStats struct { // The number of matches found. NumberOfMatchesFound int64 // The number of merges completed. NumberOfMergesDone int64 // The number of profiles reviewed. NumberOfProfilesReviewed int64 // contains filtered or unexported fields }
Statistics about the Identity Resolution Job.
type ListCalculatedAttributeDefinitionItem ¶
type ListCalculatedAttributeDefinitionItem struct { // The unique name of the calculated attribute. CalculatedAttributeName *string // The threshold for the calculated attribute. CreatedAt *time.Time // The threshold for the calculated attribute. Description *string // The display name of the calculated attribute. DisplayName *string // The timestamp of when the calculated attribute definition was most recently // edited. LastUpdatedAt *time.Time // The tags used to organize, track, or control access for this resource. Tags map[string]string // contains filtered or unexported fields }
The details of a single calculated attribute definition.
type ListCalculatedAttributeForProfileItem ¶
type ListCalculatedAttributeForProfileItem struct { // The unique name of the calculated attribute. CalculatedAttributeName *string // The display name of the calculated attribute. DisplayName *string // Indicates whether the calculated attribute’s value is based on partial data. If // data is partial, it is set to true. IsDataPartial *string // The value of the calculated attribute. Value *string // contains filtered or unexported fields }
The details of a single calculated attribute for a profile.
type ListDomainItem ¶
type ListDomainItem struct { // The timestamp of when the domain was created. // // This member is required. CreatedAt *time.Time // The unique name of the domain. // // This member is required. DomainName *string // The timestamp of when the domain was most recently edited. // // This member is required. LastUpdatedAt *time.Time // The tags used to organize, track, or control access for this resource. Tags map[string]string // contains filtered or unexported fields }
An object in a list that represents a domain.
type ListIntegrationItem ¶
type ListIntegrationItem struct { // The timestamp of when the domain was created. // // This member is required. CreatedAt *time.Time // The unique name of the domain. // // This member is required. DomainName *string // The timestamp of when the domain was most recently edited. // // This member is required. LastUpdatedAt *time.Time // The URI of the S3 bucket or any other type of data source. // // This member is required. Uri *string // Boolean that shows if the Flow that's associated with the Integration is // created in Amazon Appflow, or with ObjectTypeName equals _unstructured via // API/CLI in flowDefinition. IsUnstructured *bool // The name of the profile object type. ObjectTypeName *string // A map in which each key is an event type from an external application such as // Segment or Shopify, and each value is an ObjectTypeName (template) used to // ingest the event. It supports the following event types: SegmentIdentify , // ShopifyCreateCustomers , ShopifyUpdateCustomers , ShopifyCreateDraftOrders , // ShopifyUpdateDraftOrders , ShopifyCreateOrders , and ShopifyUpdatedOrders . ObjectTypeNames map[string]string // The tags used to organize, track, or control access for this resource. Tags map[string]string // Unique identifier for the workflow. WorkflowId *string // contains filtered or unexported fields }
An integration in list of integrations.
type ListProfileObjectTypeItem ¶
type ListProfileObjectTypeItem struct { // Description of the profile object type. // // This member is required. Description *string // The name of the profile object type. // // This member is required. ObjectTypeName *string // The timestamp of when the domain was created. CreatedAt *time.Time // The timestamp of when the domain was most recently edited. LastUpdatedAt *time.Time // The tags used to organize, track, or control access for this resource. Tags map[string]string // contains filtered or unexported fields }
A ProfileObjectType instance.
type ListProfileObjectTypeTemplateItem ¶
type ListProfileObjectTypeTemplateItem struct { // The name of the source of the object template. SourceName *string // The source of the object template. SourceObject *string // A unique identifier for the object template. TemplateId *string // contains filtered or unexported fields }
A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.
type ListProfileObjectsItem ¶
type ListProfileObjectsItem struct { // A JSON representation of a ProfileObject that belongs to a profile. Object *string // Specifies the kind of object being added to a profile, such as // "Salesforce-Account." ObjectTypeName *string // The unique identifier of the ProfileObject generated by the service. ProfileObjectUniqueKey *string // contains filtered or unexported fields }
A ProfileObject in a list of ProfileObjects.
type ListWorkflowsItem ¶
type ListWorkflowsItem struct { // Creation timestamp for workflow. // // This member is required. CreatedAt *time.Time // Last updated timestamp for workflow. // // This member is required. LastUpdatedAt *time.Time // Status of workflow execution. // // This member is required. Status Status // Description for workflow execution status. // // This member is required. StatusDescription *string // Unique identifier for the workflow. // // This member is required. WorkflowId *string // The type of workflow. The only supported value is APPFLOW_INTEGRATION. // // This member is required. WorkflowType WorkflowType // contains filtered or unexported fields }
A workflow in list of workflows.
type LogicalOperator ¶
type LogicalOperator string
const ( LogicalOperatorAnd LogicalOperator = "AND" LogicalOperatorOr LogicalOperator = "OR" )
Enum values for LogicalOperator
func (LogicalOperator) Values ¶
func (LogicalOperator) Values() []LogicalOperator
Values returns all known values for LogicalOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MarketoConnectorOperator ¶
type MarketoConnectorOperator string
const ( MarketoConnectorOperatorProjection MarketoConnectorOperator = "PROJECTION" MarketoConnectorOperatorLessThan MarketoConnectorOperator = "LESS_THAN" MarketoConnectorOperatorGreaterThan MarketoConnectorOperator = "GREATER_THAN" MarketoConnectorOperatorBetween MarketoConnectorOperator = "BETWEEN" MarketoConnectorOperatorAddition MarketoConnectorOperator = "ADDITION" MarketoConnectorOperatorMultiplication MarketoConnectorOperator = "MULTIPLICATION" MarketoConnectorOperatorDivision MarketoConnectorOperator = "DIVISION" MarketoConnectorOperatorSubtraction MarketoConnectorOperator = "SUBTRACTION" MarketoConnectorOperatorMaskAll MarketoConnectorOperator = "MASK_ALL" MarketoConnectorOperatorMaskFirstN MarketoConnectorOperator = "MASK_FIRST_N" MarketoConnectorOperatorMaskLastN MarketoConnectorOperator = "MASK_LAST_N" MarketoConnectorOperatorValidateNonNull MarketoConnectorOperator = "VALIDATE_NON_NULL" MarketoConnectorOperatorValidateNonZero MarketoConnectorOperator = "VALIDATE_NON_ZERO" MarketoConnectorOperatorValidateNonNegative MarketoConnectorOperator = "VALIDATE_NON_NEGATIVE" MarketoConnectorOperatorValidateNumeric MarketoConnectorOperator = "VALIDATE_NUMERIC" MarketoConnectorOperatorNoOp MarketoConnectorOperator = "NO_OP" )
Enum values for MarketoConnectorOperator
func (MarketoConnectorOperator) Values ¶
func (MarketoConnectorOperator) Values() []MarketoConnectorOperator
Values returns all known values for MarketoConnectorOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type MarketoSourceProperties ¶
type MarketoSourceProperties struct { // The object specified in the Marketo flow source. // // This member is required. Object *string // contains filtered or unexported fields }
The properties that are applied when Marketo is being used as a source.
type MatchItem ¶
type MatchItem struct { // A number between 0 and 1, where a higher score means higher similarity. // Examining match confidence scores lets you distinguish between groups of similar // records in which the system is highly confident (which you may decide to merge), // groups of similar records about which the system is uncertain (which you may // decide to have reviewed by a human), and groups of similar records that the // system deems to be unlikely (which you may decide to reject). Given confidence // scores vary as per the data input, it should not be used an absolute measure of // matching quality. ConfidenceScore *float64 // The unique identifiers for this group of profiles that match. MatchId *string // A list of identifiers for profiles that match. ProfileIds []string // contains filtered or unexported fields }
The Match group object.
type MatchType ¶
type MatchType string
type MatchingRequest ¶
type MatchingRequest struct { // The flag that enables the matching process of duplicate profiles. // // This member is required. Enabled *bool // Configuration information about the auto-merging process. AutoMerging *AutoMerging // Configuration information for exporting Identity Resolution results, for // example, to an S3 bucket. ExportingConfig *ExportingConfig // The day and time when do you want to start the Identity Resolution Job every // week. JobSchedule *JobSchedule // contains filtered or unexported fields }
The flag that enables the matching process of duplicate profiles.
type MatchingResponse ¶
type MatchingResponse struct { // Configuration information about the auto-merging process. AutoMerging *AutoMerging // The flag that enables the matching process of duplicate profiles. Enabled *bool // Configuration information for exporting Identity Resolution results, for // example, to an S3 bucket. ExportingConfig *ExportingConfig // The day and time when do you want to start the Identity Resolution Job every // week. JobSchedule *JobSchedule // contains filtered or unexported fields }
The flag that enables the matching process of duplicate profiles.
type MatchingRule ¶
type MatchingRule struct { // A single rule level of the MatchRules . Configures how the rule-based matching // process should match profiles. // // This member is required. Rule []string // contains filtered or unexported fields }
Specifies how does the rule-based matching process should match profiles. You can choose from the following attributes to build the matching Rule:
AccountNumber
Address.Address
Address.City
Address.Country
Address.County
Address.PostalCode
Address.State
Address.Province
BirthDate
BusinessName
EmailAddress
FirstName
Gender
LastName
MiddleName
PhoneNumber
Any customized profile attributes that start with the Attributes
type ObjectFilter ¶
type ObjectFilter struct { // A searchable identifier of a profile object. The predefined keys you can use to // search for _asset include: _assetId , _assetName , and _serialNumber . The // predefined keys you can use to search for _case include: _caseId . The // predefined keys you can use to search for _order include: _orderId . // // This member is required. KeyName *string // A list of key values. // // This member is required. Values []string // contains filtered or unexported fields }
The filter applied to ListProfileObjects response to include profile objects with the specified index values.
type ObjectTypeField ¶
type ObjectTypeField struct { // The content type of the field. Used for determining equality when searching. ContentType FieldContentType // A field of a ProfileObject. For example: _source.FirstName, where “_source” is // a ProfileObjectType of a Zendesk user and “FirstName” is a field in that // ObjectType. Source *string // The location of the data in the standard ProfileObject model. For example: // _profile.Address.PostalCode. Target *string // contains filtered or unexported fields }
Represents a field in a ProfileObjectType.
type ObjectTypeKey ¶
type ObjectTypeKey struct { // The reference for the key name of the fields map. FieldNames []string // The types of keys that a ProfileObject can have. Each ProfileObject can have // only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER // means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or // ORDER respectively. UNIQUE means that it can be used to uniquely identify an // object. If a key a is marked as SECONDARY, it will be used to search for // profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is // only used to match a profile but is not persisted to be used for searching of // the profile. A NEW_ONLY key is only used if the profile does not already exist // before the object is ingested, otherwise it is only used for matching objects to // profiles. StandardIdentifiers []StandardIdentifier // contains filtered or unexported fields }
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.
type Operator ¶
type Operator string
type OperatorPropertiesKeys ¶
type OperatorPropertiesKeys string
const ( OperatorPropertiesKeysValue OperatorPropertiesKeys = "VALUE" OperatorPropertiesKeysValues OperatorPropertiesKeys = "VALUES" OperatorPropertiesKeysDataType OperatorPropertiesKeys = "DATA_TYPE" OperatorPropertiesKeysUpperBound OperatorPropertiesKeys = "UPPER_BOUND" OperatorPropertiesKeysLowerBound OperatorPropertiesKeys = "LOWER_BOUND" OperatorPropertiesKeysSourceDataType OperatorPropertiesKeys = "SOURCE_DATA_TYPE" OperatorPropertiesKeysDestinationDataType OperatorPropertiesKeys = "DESTINATION_DATA_TYPE" OperatorPropertiesKeysValidationAction OperatorPropertiesKeys = "VALIDATION_ACTION" OperatorPropertiesKeysMaskValue OperatorPropertiesKeys = "MASK_VALUE" OperatorPropertiesKeysMaskLength OperatorPropertiesKeys = "MASK_LENGTH" OperatorPropertiesKeysTruncateLength OperatorPropertiesKeys = "TRUNCATE_LENGTH" OperatorPropertiesKeysMathOperationFieldsOrder OperatorPropertiesKeys = "MATH_OPERATION_FIELDS_ORDER" OperatorPropertiesKeysConcatFormat OperatorPropertiesKeys = "CONCAT_FORMAT" OperatorPropertiesKeysSubfieldCategoryMap OperatorPropertiesKeys = "SUBFIELD_CATEGORY_MAP" )
Enum values for OperatorPropertiesKeys
func (OperatorPropertiesKeys) Values ¶
func (OperatorPropertiesKeys) Values() []OperatorPropertiesKeys
Values returns all known values for OperatorPropertiesKeys. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PartyType ¶
type PartyType string
type Profile ¶
type Profile struct { // A unique account number that you have given to the customer. AccountNumber *string // Any additional information relevant to the customer’s profile. AdditionalInformation *string // A generic address associated with the customer that is not mailing, shipping, // or billing. Address *Address // A key value pair of attributes of a customer profile. Attributes map[string]string // The customer’s billing address. BillingAddress *Address // The customer’s birth date. BirthDate *string // The customer’s business email address. BusinessEmailAddress *string // The name of the customer’s business. BusinessName *string // The customer’s home phone number. BusinessPhoneNumber *string // The customer’s email address, which has not been specified as a personal or // business address. EmailAddress *string // The customer’s first name. FirstName *string // A list of items used to find a profile returned in a [SearchProfiles] response. An item is a // key-value(s) pair that matches an attribute in the profile. // // If the optional AdditionalSearchKeys parameter was included in the [SearchProfiles] request, // the FoundByItems list should be interpreted based on the LogicalOperator used // in the request: // // - AND - The profile included in the response matched all of the search keys // specified in the request. The FoundByItems will include all of the // key-value(s) pairs that were specified in the request (as this is a requirement // of AND search logic). // // - OR - The profile included in the response matched at least one of the search // keys specified in the request. The FoundByItems will include each of the // key-value(s) pairs that the profile was found by. // // The OR relationship is the default behavior if the LogicalOperator parameter is // not included in the [SearchProfiles]request. // // [SearchProfiles]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html FoundByItems []FoundByKeyValue // The gender with which the customer identifies. // // Deprecated: This member has been deprecated. Gender Gender // An alternative to Gender which accepts any string as input. GenderString *string // The customer’s home phone number. HomePhoneNumber *string // The customer’s last name. LastName *string // The customer’s mailing address. MailingAddress *Address // The customer’s middle name. MiddleName *string // The customer’s mobile phone number. MobilePhoneNumber *string // The type of profile used to describe the customer. // // Deprecated: This member has been deprecated. PartyType PartyType // An alternative to PartyType which accepts any string as input. PartyTypeString *string // The customer’s personal email address. PersonalEmailAddress *string // The customer's phone number, which has not been specified as a mobile, home, or // business number. PhoneNumber *string // The unique identifier of a customer profile. ProfileId *string // The customer’s shipping address. ShippingAddress *Address // contains filtered or unexported fields }
The standard profile of a customer.
type Range ¶
type Range struct { // The unit of time. // // This member is required. Unit Unit // The amount of time of the specified unit. // // This member is required. Value *int32 // contains filtered or unexported fields }
The relative time period over which data is included in the aggregation.
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The requested resource does not exist, or access was denied.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type RuleBasedMatchingRequest ¶
type RuleBasedMatchingRequest struct { // The flag that enables the rule-based matching process of duplicate profiles. // // This member is required. Enabled *bool // Configures information about the AttributeTypesSelector where the rule-based // identity resolution uses to match profiles. AttributeTypesSelector *AttributeTypesSelector // How the auto-merging process should resolve conflicts between different // profiles. ConflictResolution *ConflictResolution // Configuration information about the S3 bucket where Identity Resolution Jobs // writes result files. // // You need to give Customer Profiles service principal write permission to your // S3 bucket. Otherwise, you'll get an exception in the API response. For an // example policy, see [Amazon Connect Customer Profiles cross-service confused deputy prevention]. // // [Amazon Connect Customer Profiles cross-service confused deputy prevention]: https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html#customer-profiles-cross-service ExportingConfig *ExportingConfig // Configures how the rule-based matching process should match profiles. You can // have up to 15 MatchingRule in the MatchingRules . MatchingRules []MatchingRule // Indicates the maximum allowed rule level. MaxAllowedRuleLevelForMatching *int32 // [MatchingRule] // // [MatchingRule]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html MaxAllowedRuleLevelForMerging *int32 // contains filtered or unexported fields }
The request to enable the rule-based matching.
type RuleBasedMatchingResponse ¶
type RuleBasedMatchingResponse struct { // Configures information about the AttributeTypesSelector where the rule-based // identity resolution uses to match profiles. AttributeTypesSelector *AttributeTypesSelector // How the auto-merging process should resolve conflicts between different // profiles. ConflictResolution *ConflictResolution // The flag that enables the rule-based matching process of duplicate profiles. Enabled *bool // Configuration information about the S3 bucket where Identity Resolution Jobs // writes result files. // // You need to give Customer Profiles service principal write permission to your // S3 bucket. Otherwise, you'll get an exception in the API response. For an // example policy, see [Amazon Connect Customer Profiles cross-service confused deputy prevention]. // // [Amazon Connect Customer Profiles cross-service confused deputy prevention]: https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html#customer-profiles-cross-service ExportingConfig *ExportingConfig // Configures how the rule-based matching process should match profiles. You can // have up to 15 MatchingRule in the MatchingRules . MatchingRules []MatchingRule // Indicates the maximum allowed rule level. MaxAllowedRuleLevelForMatching *int32 // [MatchingRule] // // [MatchingRule]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html MaxAllowedRuleLevelForMerging *int32 // PENDING // // - The first status after configuration a rule-based matching rule. If it is // an existing domain, the rule-based Identity Resolution waits one hour before // creating the matching rule. If it is a new domain, the system will skip the // PENDING stage. // // IN_PROGRESS // // - The system is creating the rule-based matching rule. Under this status, the // system is evaluating the existing data and you can no longer change the // Rule-based matching configuration. // // ACTIVE // // - The rule is ready to use. You can change the rule a day after the status is // in ACTIVE . Status RuleBasedMatchingStatus // contains filtered or unexported fields }
The response of the Rule-based matching request.
type RuleBasedMatchingStatus ¶
type RuleBasedMatchingStatus string
const ( RuleBasedMatchingStatusPending RuleBasedMatchingStatus = "PENDING" RuleBasedMatchingStatusInProgress RuleBasedMatchingStatus = "IN_PROGRESS" RuleBasedMatchingStatusActive RuleBasedMatchingStatus = "ACTIVE" )
Enum values for RuleBasedMatchingStatus
func (RuleBasedMatchingStatus) Values ¶
func (RuleBasedMatchingStatus) Values() []RuleBasedMatchingStatus
Values returns all known values for RuleBasedMatchingStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type S3ConnectorOperator ¶
type S3ConnectorOperator string
const ( S3ConnectorOperatorProjection S3ConnectorOperator = "PROJECTION" S3ConnectorOperatorLessThan S3ConnectorOperator = "LESS_THAN" S3ConnectorOperatorGreaterThan S3ConnectorOperator = "GREATER_THAN" S3ConnectorOperatorBetween S3ConnectorOperator = "BETWEEN" S3ConnectorOperatorLessThanOrEqualTo S3ConnectorOperator = "LESS_THAN_OR_EQUAL_TO" S3ConnectorOperatorGreaterThanOrEqualTo S3ConnectorOperator = "GREATER_THAN_OR_EQUAL_TO" S3ConnectorOperatorEqualTo S3ConnectorOperator = "EQUAL_TO" S3ConnectorOperatorNotEqualTo S3ConnectorOperator = "NOT_EQUAL_TO" S3ConnectorOperatorAddition S3ConnectorOperator = "ADDITION" S3ConnectorOperatorMultiplication S3ConnectorOperator = "MULTIPLICATION" S3ConnectorOperatorDivision S3ConnectorOperator = "DIVISION" S3ConnectorOperatorSubtraction S3ConnectorOperator = "SUBTRACTION" S3ConnectorOperatorMaskAll S3ConnectorOperator = "MASK_ALL" S3ConnectorOperatorMaskFirstN S3ConnectorOperator = "MASK_FIRST_N" S3ConnectorOperatorMaskLastN S3ConnectorOperator = "MASK_LAST_N" S3ConnectorOperatorValidateNonNull S3ConnectorOperator = "VALIDATE_NON_NULL" S3ConnectorOperatorValidateNonZero S3ConnectorOperator = "VALIDATE_NON_ZERO" S3ConnectorOperatorValidateNonNegative S3ConnectorOperator = "VALIDATE_NON_NEGATIVE" S3ConnectorOperatorValidateNumeric S3ConnectorOperator = "VALIDATE_NUMERIC" S3ConnectorOperatorNoOp S3ConnectorOperator = "NO_OP" )
Enum values for S3ConnectorOperator
func (S3ConnectorOperator) Values ¶
func (S3ConnectorOperator) Values() []S3ConnectorOperator
Values returns all known values for S3ConnectorOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type S3ExportingConfig ¶
type S3ExportingConfig struct { // The name of the S3 bucket where Identity Resolution Jobs write result files. // // This member is required. S3BucketName *string // The S3 key name of the location where Identity Resolution Jobs write result // files. S3KeyName *string // contains filtered or unexported fields }
Configuration information about the S3 bucket where Identity Resolution Jobs write result files.
type S3ExportingLocation ¶
type S3ExportingLocation struct { // The name of the S3 bucket name where Identity Resolution Jobs write result // files. S3BucketName *string // The S3 key name of the location where Identity Resolution Jobs write result // files. S3KeyName *string // contains filtered or unexported fields }
The S3 location where Identity Resolution Jobs write result files.
type S3SourceProperties ¶
type S3SourceProperties struct { // The Amazon S3 bucket name where the source files are stored. // // This member is required. BucketName *string // The object key for the Amazon S3 bucket in which the source files are stored. BucketPrefix *string // contains filtered or unexported fields }
The properties that are applied when Amazon S3 is being used as the flow source.
type SalesforceConnectorOperator ¶
type SalesforceConnectorOperator string
const ( SalesforceConnectorOperatorProjection SalesforceConnectorOperator = "PROJECTION" SalesforceConnectorOperatorLessThan SalesforceConnectorOperator = "LESS_THAN" SalesforceConnectorOperatorContains SalesforceConnectorOperator = "CONTAINS" SalesforceConnectorOperatorGreaterThan SalesforceConnectorOperator = "GREATER_THAN" SalesforceConnectorOperatorBetween SalesforceConnectorOperator = "BETWEEN" SalesforceConnectorOperatorLessThanOrEqualTo SalesforceConnectorOperator = "LESS_THAN_OR_EQUAL_TO" SalesforceConnectorOperatorGreaterThanOrEqualTo SalesforceConnectorOperator = "GREATER_THAN_OR_EQUAL_TO" SalesforceConnectorOperatorEqualTo SalesforceConnectorOperator = "EQUAL_TO" SalesforceConnectorOperatorNotEqualTo SalesforceConnectorOperator = "NOT_EQUAL_TO" SalesforceConnectorOperatorAddition SalesforceConnectorOperator = "ADDITION" SalesforceConnectorOperatorMultiplication SalesforceConnectorOperator = "MULTIPLICATION" SalesforceConnectorOperatorDivision SalesforceConnectorOperator = "DIVISION" SalesforceConnectorOperatorSubtraction SalesforceConnectorOperator = "SUBTRACTION" SalesforceConnectorOperatorMaskAll SalesforceConnectorOperator = "MASK_ALL" SalesforceConnectorOperatorMaskFirstN SalesforceConnectorOperator = "MASK_FIRST_N" SalesforceConnectorOperatorMaskLastN SalesforceConnectorOperator = "MASK_LAST_N" SalesforceConnectorOperatorValidateNonNull SalesforceConnectorOperator = "VALIDATE_NON_NULL" SalesforceConnectorOperatorValidateNonZero SalesforceConnectorOperator = "VALIDATE_NON_ZERO" SalesforceConnectorOperatorValidateNonNegative SalesforceConnectorOperator = "VALIDATE_NON_NEGATIVE" SalesforceConnectorOperatorValidateNumeric SalesforceConnectorOperator = "VALIDATE_NUMERIC" SalesforceConnectorOperatorNoOp SalesforceConnectorOperator = "NO_OP" )
Enum values for SalesforceConnectorOperator
func (SalesforceConnectorOperator) Values ¶
func (SalesforceConnectorOperator) Values() []SalesforceConnectorOperator
Values returns all known values for SalesforceConnectorOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SalesforceSourceProperties ¶
type SalesforceSourceProperties struct { // The object specified in the Salesforce flow source. // // This member is required. Object *string // The flag that enables dynamic fetching of new (recently added) fields in the // Salesforce objects while running a flow. EnableDynamicFieldUpdate bool // Indicates whether Amazon AppFlow includes deleted files in the flow run. IncludeDeletedRecords bool // contains filtered or unexported fields }
The properties that are applied when Salesforce is being used as a source.
type ScheduledTriggerProperties ¶
type ScheduledTriggerProperties struct { // The scheduling expression that determines the rate at which the schedule will // run, for example rate (5 minutes). // // This member is required. ScheduleExpression *string // Specifies whether a scheduled flow has an incremental data transfer or a // complete data transfer for each flow run. DataPullMode DataPullMode // Specifies the date range for the records to import from the connector in the // first flow run. FirstExecutionFrom *time.Time // Specifies the scheduled end time for a scheduled-trigger flow. ScheduleEndTime *time.Time // Specifies the optional offset that is added to the time interval for a // schedule-triggered flow. ScheduleOffset *int64 // Specifies the scheduled start time for a scheduled-trigger flow. ScheduleStartTime *time.Time // Specifies the time zone used when referring to the date and time of a // scheduled-triggered flow, such as America/New_York. Timezone *string // contains filtered or unexported fields }
Specifies the configuration details of a scheduled-trigger flow that you define. Currently, these settings only apply to the scheduled-trigger type.
type ServiceNowConnectorOperator ¶
type ServiceNowConnectorOperator string
const ( ServiceNowConnectorOperatorProjection ServiceNowConnectorOperator = "PROJECTION" ServiceNowConnectorOperatorContains ServiceNowConnectorOperator = "CONTAINS" ServiceNowConnectorOperatorLessThan ServiceNowConnectorOperator = "LESS_THAN" ServiceNowConnectorOperatorGreaterThan ServiceNowConnectorOperator = "GREATER_THAN" ServiceNowConnectorOperatorBetween ServiceNowConnectorOperator = "BETWEEN" ServiceNowConnectorOperatorLessThanOrEqualTo ServiceNowConnectorOperator = "LESS_THAN_OR_EQUAL_TO" ServiceNowConnectorOperatorGreaterThanOrEqualTo ServiceNowConnectorOperator = "GREATER_THAN_OR_EQUAL_TO" ServiceNowConnectorOperatorEqualTo ServiceNowConnectorOperator = "EQUAL_TO" ServiceNowConnectorOperatorNotEqualTo ServiceNowConnectorOperator = "NOT_EQUAL_TO" ServiceNowConnectorOperatorAddition ServiceNowConnectorOperator = "ADDITION" ServiceNowConnectorOperatorMultiplication ServiceNowConnectorOperator = "MULTIPLICATION" ServiceNowConnectorOperatorDivision ServiceNowConnectorOperator = "DIVISION" ServiceNowConnectorOperatorSubtraction ServiceNowConnectorOperator = "SUBTRACTION" ServiceNowConnectorOperatorMaskAll ServiceNowConnectorOperator = "MASK_ALL" ServiceNowConnectorOperatorMaskFirstN ServiceNowConnectorOperator = "MASK_FIRST_N" ServiceNowConnectorOperatorMaskLastN ServiceNowConnectorOperator = "MASK_LAST_N" ServiceNowConnectorOperatorValidateNonNull ServiceNowConnectorOperator = "VALIDATE_NON_NULL" ServiceNowConnectorOperatorValidateNonZero ServiceNowConnectorOperator = "VALIDATE_NON_ZERO" ServiceNowConnectorOperatorValidateNonNegative ServiceNowConnectorOperator = "VALIDATE_NON_NEGATIVE" ServiceNowConnectorOperatorValidateNumeric ServiceNowConnectorOperator = "VALIDATE_NUMERIC" ServiceNowConnectorOperatorNoOp ServiceNowConnectorOperator = "NO_OP" )
Enum values for ServiceNowConnectorOperator
func (ServiceNowConnectorOperator) Values ¶
func (ServiceNowConnectorOperator) Values() []ServiceNowConnectorOperator
Values returns all known values for ServiceNowConnectorOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ServiceNowSourceProperties ¶
type ServiceNowSourceProperties struct { // The object specified in the ServiceNow flow source. // // This member is required. Object *string // contains filtered or unexported fields }
The properties that are applied when ServiceNow is being used as a source.
type SourceConnectorProperties ¶
type SourceConnectorProperties struct { // The properties that are applied when Marketo is being used as a source. Marketo *MarketoSourceProperties // The properties that are applied when Amazon S3 is being used as the flow source. S3 *S3SourceProperties // The properties that are applied when Salesforce is being used as a source. Salesforce *SalesforceSourceProperties // The properties that are applied when ServiceNow is being used as a source. ServiceNow *ServiceNowSourceProperties // The properties that are applied when using Zendesk as a flow source. Zendesk *ZendeskSourceProperties // contains filtered or unexported fields }
Specifies the information that is required to query a particular Amazon AppFlow connector. Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.
type SourceConnectorType ¶
type SourceConnectorType string
const ( SourceConnectorTypeSalesforce SourceConnectorType = "Salesforce" SourceConnectorTypeMarketo SourceConnectorType = "Marketo" SourceConnectorTypeZendesk SourceConnectorType = "Zendesk" SourceConnectorTypeServicenow SourceConnectorType = "Servicenow" SourceConnectorTypeS3 SourceConnectorType = "S3" )
Enum values for SourceConnectorType
func (SourceConnectorType) Values ¶
func (SourceConnectorType) Values() []SourceConnectorType
Values returns all known values for SourceConnectorType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type SourceFlowConfig ¶
type SourceFlowConfig struct { // The type of connector, such as Salesforce, Marketo, and so on. // // This member is required. ConnectorType SourceConnectorType // Specifies the information that is required to query a particular source // connector. // // This member is required. SourceConnectorProperties *SourceConnectorProperties // The name of the AppFlow connector profile. This name must be unique for each // connector profile in the AWS account. ConnectorProfileName *string // Defines the configuration for a scheduled incremental data pull. If a valid // configuration is provided, the fields specified in the configuration are used // when querying for the incremental data pull. IncrementalPullConfig *IncrementalPullConfig // contains filtered or unexported fields }
Contains information about the configuration of the source connector used in the flow.
type StandardIdentifier ¶
type StandardIdentifier string
const ( StandardIdentifierProfile StandardIdentifier = "PROFILE" StandardIdentifierAsset StandardIdentifier = "ASSET" StandardIdentifierCase StandardIdentifier = "CASE" StandardIdentifierUnique StandardIdentifier = "UNIQUE" StandardIdentifierSecondary StandardIdentifier = "SECONDARY" StandardIdentifierLookupOnly StandardIdentifier = "LOOKUP_ONLY" StandardIdentifierNewOnly StandardIdentifier = "NEW_ONLY" StandardIdentifierOrder StandardIdentifier = "ORDER" )
Enum values for StandardIdentifier
func (StandardIdentifier) Values ¶
func (StandardIdentifier) Values() []StandardIdentifier
Values returns all known values for StandardIdentifier. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Statistic ¶
type Statistic string
const ( StatisticFirstOccurrence Statistic = "FIRST_OCCURRENCE" StatisticLastOccurrence Statistic = "LAST_OCCURRENCE" StatisticCount Statistic = "COUNT" StatisticSum Statistic = "SUM" StatisticMinimum Statistic = "MINIMUM" StatisticMaximum Statistic = "MAXIMUM" StatisticAverage Statistic = "AVERAGE" StatisticMaxOccurrence Statistic = "MAX_OCCURRENCE" )
Enum values for Statistic
type Status ¶
type Status string
type Task ¶
type Task struct { // The source fields to which a particular task is applied. // // This member is required. SourceFields []string // Specifies the particular task implementation that Amazon AppFlow performs. // // This member is required. TaskType TaskType // The operation to be performed on the provided source fields. ConnectorOperator *ConnectorOperator // A field in a destination connector, or a field value against which Amazon // AppFlow validates a source field. DestinationField *string // A map used to store task-related information. The service looks for particular // information based on the TaskType. TaskProperties map[string]string // contains filtered or unexported fields }
A class for modeling different type of tasks. Task implementation varies based on the TaskType.
type TaskType ¶
type TaskType string
type Threshold ¶
type Threshold struct { // The operator of the threshold. // // This member is required. Operator Operator // The value of the threshold. // // This member is required. Value *string // contains filtered or unexported fields }
The threshold for the calculated attribute.
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
You exceeded the maximum number of requests.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type TriggerConfig ¶
type TriggerConfig struct { // Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event. // // This member is required. TriggerType TriggerType // Specifies the configuration details of a schedule-triggered flow that you // define. Currently, these settings only apply to the Scheduled trigger type. TriggerProperties *TriggerProperties // contains filtered or unexported fields }
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
type TriggerProperties ¶
type TriggerProperties struct { // Specifies the configuration details of a schedule-triggered flow that you // define. Scheduled *ScheduledTriggerProperties // contains filtered or unexported fields }
Specifies the configuration details that control the trigger for a flow. Currently, these settings only apply to the Scheduled trigger type.
type TriggerType ¶
type TriggerType string
const ( TriggerTypeScheduled TriggerType = "Scheduled" TriggerTypeEvent TriggerType = "Event" TriggerTypeOndemand TriggerType = "OnDemand" )
Enum values for TriggerType
func (TriggerType) Values ¶
func (TriggerType) Values() []TriggerType
Values returns all known values for TriggerType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type UpdateAddress ¶
type UpdateAddress struct { // The first line of a customer address. Address1 *string // The second line of a customer address. Address2 *string // The third line of a customer address. Address3 *string // The fourth line of a customer address. Address4 *string // The city in which a customer lives. City *string // The country in which a customer lives. Country *string // The county in which a customer lives. County *string // The postal code of a customer address. PostalCode *string // The province in which a customer lives. Province *string // The state in which a customer lives. State *string // contains filtered or unexported fields }
Updates associated with the address properties of a customer profile.
type WorkflowAttributes ¶
type WorkflowAttributes struct { // Workflow attributes specific to APPFLOW_INTEGRATION workflow. AppflowIntegration *AppflowIntegrationWorkflowAttributes // contains filtered or unexported fields }
Structure to hold workflow attributes.
type WorkflowMetrics ¶
type WorkflowMetrics struct { // Workflow execution metrics for APPFLOW_INTEGRATION workflow. AppflowIntegration *AppflowIntegrationWorkflowMetrics // contains filtered or unexported fields }
Generic object containing workflow execution metrics.
type WorkflowStepItem ¶
type WorkflowStepItem struct { // Workflow step information specific to APPFLOW_INTEGRATION workflow. AppflowIntegration *AppflowIntegrationWorkflowStep // contains filtered or unexported fields }
List containing steps in workflow.
type WorkflowType ¶
type WorkflowType string
const (
WorkflowTypeAppflowIntegration WorkflowType = "APPFLOW_INTEGRATION"
)
Enum values for WorkflowType
func (WorkflowType) Values ¶
func (WorkflowType) Values() []WorkflowType
Values returns all known values for WorkflowType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ZendeskConnectorOperator ¶
type ZendeskConnectorOperator string
const ( ZendeskConnectorOperatorProjection ZendeskConnectorOperator = "PROJECTION" ZendeskConnectorOperatorGreaterThan ZendeskConnectorOperator = "GREATER_THAN" ZendeskConnectorOperatorAddition ZendeskConnectorOperator = "ADDITION" ZendeskConnectorOperatorMultiplication ZendeskConnectorOperator = "MULTIPLICATION" ZendeskConnectorOperatorDivision ZendeskConnectorOperator = "DIVISION" ZendeskConnectorOperatorSubtraction ZendeskConnectorOperator = "SUBTRACTION" ZendeskConnectorOperatorMaskAll ZendeskConnectorOperator = "MASK_ALL" ZendeskConnectorOperatorMaskFirstN ZendeskConnectorOperator = "MASK_FIRST_N" ZendeskConnectorOperatorMaskLastN ZendeskConnectorOperator = "MASK_LAST_N" ZendeskConnectorOperatorValidateNonNull ZendeskConnectorOperator = "VALIDATE_NON_NULL" ZendeskConnectorOperatorValidateNonZero ZendeskConnectorOperator = "VALIDATE_NON_ZERO" ZendeskConnectorOperatorValidateNonNegative ZendeskConnectorOperator = "VALIDATE_NON_NEGATIVE" ZendeskConnectorOperatorValidateNumeric ZendeskConnectorOperator = "VALIDATE_NUMERIC" ZendeskConnectorOperatorNoOp ZendeskConnectorOperator = "NO_OP" )
Enum values for ZendeskConnectorOperator
func (ZendeskConnectorOperator) Values ¶
func (ZendeskConnectorOperator) Values() []ZendeskConnectorOperator
Values returns all known values for ZendeskConnectorOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.