types

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 28, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

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. HTTP Status Code: 403

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 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 ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ErrorDetails 

type ErrorDetails struct {

	// The error message from the job, if there is one.
	ErrorMessage *string
	// contains filtered or unexported fields
}

An object containing an error message, if there was an error.

type ExceedsLimitException 

type ExceedsLimitException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. The error message describes the limit exceeded. HTTP Status Code: 402

func (*ExceedsLimitException) Error 

func (e *ExceedsLimitException) Error() string

func (*ExceedsLimitException) ErrorCode 

func (e *ExceedsLimitException) ErrorCode() string

func (*ExceedsLimitException) ErrorFault 

func (e *ExceedsLimitException) ErrorFault() smithy.ErrorFault

func (*ExceedsLimitException) ErrorMessage 

func (e *ExceedsLimitException) ErrorMessage() string

type IncrementalRunConfig 

type IncrementalRunConfig struct {

	// The type of incremental run. It takes only one value: IMMEDIATE .
	IncrementalRunType IncrementalRunType
	// contains filtered or unexported fields
}

An object which defines an incremental run type and has only incrementalRunType as a field.

type IncrementalRunType 

type IncrementalRunType string
const (
	IncrementalRunTypeImmediate IncrementalRunType = "IMMEDIATE"
)

Enum values for IncrementalRunType

func (IncrementalRunType) Values 

func (IncrementalRunType) Values() []IncrementalRunType

Values returns all known values for IncrementalRunType. 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 InputSource 

type InputSource struct {

	// An Glue table ARN for the input source table.
	//
	// This member is required.
	InputSourceARN *string

	// The name of the schema to be retrieved.
	//
	// This member is required.
	SchemaName *string

	// Normalizes the attributes defined in the schema in the input data. For example,
	// if an attribute has an AttributeType of PHONE_NUMBER , and the data in the input
	// table is in a format of 1234567890, Entity Resolution will normalize this field
	// in the output to (123)-456-7890.
	ApplyNormalization *bool
	// contains filtered or unexported fields
}

An object containing InputSourceARN , SchemaName , and ApplyNormalization .

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500

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 JobMetrics 

type JobMetrics struct {

	// The total number of input records.
	InputRecords *int32

	// The total number of matchID s generated.
	MatchIDs *int32

	// The total number of records that did not get processed,
	RecordsNotProcessed *int32

	// The total number of records processed.
	TotalRecordsProcessed *int32
	// contains filtered or unexported fields
}

An object containing InputRecords , TotalRecordsProcessed , MatchIDs , and RecordsNotProcessed .

type JobStatus 

type JobStatus string
const (
	JobStatusRunning   JobStatus = "RUNNING"
	JobStatusSucceeded JobStatus = "SUCCEEDED"
	JobStatusFailed    JobStatus = "FAILED"
	JobStatusQueued    JobStatus = "QUEUED"
)

Enum values for JobStatus

func (JobStatus) Values 

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. 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 JobSummary 

type JobSummary struct {

	// The ID of the job.
	//
	// This member is required.
	JobId *string

	// The time at which the job was started.
	//
	// This member is required.
	StartTime *time.Time

	// The current status of the job. Either running , succeeded , queued , or failed .
	//
	// This member is required.
	Status JobStatus

	// The time at which the job has finished.
	EndTime *time.Time
	// contains filtered or unexported fields
}

An object containing the JobId , Status , StartTime , and EndTime of a job.

type MatchingWorkflowSummary 

type MatchingWorkflowSummary struct {

	// The timestamp of when the workflow was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The timestamp of when the workflow was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// The ARN (Amazon Resource Name) that Entity Resolution generated for the
	// MatchingWorkflow .
	//
	// This member is required.
	WorkflowArn *string

	// The name of the workflow.
	//
	// This member is required.
	WorkflowName *string
	// contains filtered or unexported fields
}

A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName , WorkflowArn , CreatedAt , UpdatedAt .

type OutputAttribute 

type OutputAttribute struct {

	// A name of a column to be written to the output. This must be an InputField name
	// in the schema mapping.
	//
	// This member is required.
	Name *string

	// Enables the ability to hash the column values in the output.
	Hashed *bool
	// contains filtered or unexported fields
}

A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

type OutputSource 

type OutputSource struct {

	// A list of OutputAttribute objects, each of which have the fields Name and
	// Hashed. Each of these objects selects a column to be included in the output
	// table, and whether the values of the column should be hashed.
	//
	// This member is required.
	Output []OutputAttribute

	// The S3 path to which Entity Resolution will write the output table.
	//
	// This member is required.
	OutputS3Path *string

	// Normalizes the attributes defined in the schema in the input data. For example,
	// if an attribute has an AttributeType of PHONE_NUMBER , and the data in the input
	// table is in a format of 1234567890, Entity Resolution will normalize this field
	// in the output to (123)-456-7890.
	ApplyNormalization *bool

	// Customer KMS ARN for encryption at rest. If not provided, system will use an
	// Entity Resolution managed KMS key.
	KMSArn *string
	// contains filtered or unexported fields
}

A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

type ResolutionTechniques 

type ResolutionTechniques struct {

	// There are two types of matching, RULE_MATCHING and ML_MATCHING
	ResolutionType ResolutionType

	// An object which defines the list of matching rules to run and has a field Rules
	// , which is a list of rule objects.
	RuleBasedProperties *RuleBasedProperties
	// contains filtered or unexported fields
}

An object which defines the resolutionType and the ruleBasedProperties

type ResolutionType 

type ResolutionType string
const (
	ResolutionTypeRuleMatching ResolutionType = "RULE_MATCHING"
	ResolutionTypeMlMatching   ResolutionType = "ML_MATCHING"
)

Enum values for ResolutionType

func (ResolutionType) Values 

func (ResolutionType) Values() []ResolutionType

Values returns all known values for ResolutionType. 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 ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource could not be found. HTTP Status Code: 404

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 Rule 

type Rule struct {

	// A list of MatchingKeys . The MatchingKeys must have been defined in the
	// SchemaMapping . Two records are considered to match according to this rule if
	// all of the MatchingKeys match.
	//
	// This member is required.
	MatchingKeys []string

	// A name for the matching rule.
	//
	// This member is required.
	RuleName *string
	// contains filtered or unexported fields
}

An object containing RuleName , and MatchingKeys .

type RuleBasedProperties 

type RuleBasedProperties struct {

	// 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.
	//
	// This member is required.
	AttributeMatchingModel AttributeMatchingModel

	// A list of Rule objects, each of which have fields RuleName and MatchingKeys .
	//
	// This member is required.
	Rules []Rule
	// contains filtered or unexported fields
}

An object which defines the list of matching rules to run and has a field Rules , which is a list of rule objects.

type SchemaAttributeType 

type SchemaAttributeType string
const (
	SchemaAttributeTypeName              SchemaAttributeType = "NAME"
	SchemaAttributeTypeNameFirst         SchemaAttributeType = "NAME_FIRST"
	SchemaAttributeTypeNameMiddle        SchemaAttributeType = "NAME_MIDDLE"
	SchemaAttributeTypeNameLast          SchemaAttributeType = "NAME_LAST"
	SchemaAttributeTypeAddress           SchemaAttributeType = "ADDRESS"
	SchemaAttributeTypeAddressStreet1    SchemaAttributeType = "ADDRESS_STREET1"
	SchemaAttributeTypeAddressStreet2    SchemaAttributeType = "ADDRESS_STREET2"
	SchemaAttributeTypeAddressStreet3    SchemaAttributeType = "ADDRESS_STREET3"
	SchemaAttributeTypeAddressCity       SchemaAttributeType = "ADDRESS_CITY"
	SchemaAttributeTypeAddressState      SchemaAttributeType = "ADDRESS_STATE"
	SchemaAttributeTypeAddressCountry    SchemaAttributeType = "ADDRESS_COUNTRY"
	SchemaAttributeTypeAddressPostalcode SchemaAttributeType = "ADDRESS_POSTALCODE"
	SchemaAttributeTypePhone             SchemaAttributeType = "PHONE"
	SchemaAttributeTypePhoneNumber       SchemaAttributeType = "PHONE_NUMBER"
	SchemaAttributeTypePhoneCountrycode  SchemaAttributeType = "PHONE_COUNTRYCODE"
	SchemaAttributeTypeEmailAddress      SchemaAttributeType = "EMAIL_ADDRESS"
	SchemaAttributeTypeUniqueId          SchemaAttributeType = "UNIQUE_ID"
	SchemaAttributeTypeDate              SchemaAttributeType = "DATE"
	SchemaAttributeTypeString            SchemaAttributeType = "STRING"
)

Enum values for SchemaAttributeType

func (SchemaAttributeType) Values 

func (SchemaAttributeType) Values() []SchemaAttributeType

Values returns all known values for SchemaAttributeType. 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 SchemaInputAttribute 

type SchemaInputAttribute struct {

	// A string containing the field name.
	//
	// This member is required.
	FieldName *string

	// The type of the attribute, selected from a list of values.
	//
	// This member is required.
	Type SchemaAttributeType

	// Instruct Entity Resolution to combine several columns into a unified column
	// with the identical attribute type. For example, when working with columns such
	// as first_name, middle_name, and last_name, assigning them a common GroupName
	// will prompt Entity Resolution to concatenate them into a single value.
	GroupName *string

	// A key that allows grouping of multiple input attributes into a unified matching
	// group. For example, let's consider a scenario where the source table contains
	// various addresses, such as business_address and shipping_address. By assigning
	// the MatchKey Address' to both attributes, Entity Resolution will match records
	// across these fields to create a consolidated matching group. If no MatchKey is
	// specified for a column, it won't be utilized for matching purposes but will
	// still be included in the output table.
	MatchKey *string
	// contains filtered or unexported fields
}

An object containing FieldField , Type , GroupName , and MatchKey .

type SchemaMappingSummary 

type SchemaMappingSummary struct {

	// The timestamp of when the SchemaMapping was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The ARN (Amazon Resource Name) that Entity Resolution generated for the
	// SchemaMapping .
	//
	// This member is required.
	SchemaArn *string

	// The name of the schema.
	//
	// This member is required.
	SchemaName *string

	// The timestamp of when the SchemaMapping was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

An object containing SchemaName , SchemaArn , CreatedAt , and UpdatedAt .

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling. HTTP Status Code: 429

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 ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.