Documentation ¶
Overview ¶
Package entityresolution provides the API client, operations, and parameter types for AWS EntityResolution.
Welcome to the AWS Entity Resolution API Reference. AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities that enable developers and analysts at advertising and marketing companies to build an accurate and complete view of their consumers. With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers, such as name, email address, and phone number. This holds true even when these records have incomplete or conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a customer relationship management (CRM) system, which includes account information like first name, last name, postal address, phone number, and email address, with a source record from a marketing system containing campaign information, such as username and email address. To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the AWS Entity Resolution User Guide (https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html) .
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- type Client
- func (c *Client) CreateMatchingWorkflow(ctx context.Context, params *CreateMatchingWorkflowInput, ...) (*CreateMatchingWorkflowOutput, error)
- func (c *Client) CreateSchemaMapping(ctx context.Context, params *CreateSchemaMappingInput, ...) (*CreateSchemaMappingOutput, error)
- func (c *Client) DeleteMatchingWorkflow(ctx context.Context, params *DeleteMatchingWorkflowInput, ...) (*DeleteMatchingWorkflowOutput, error)
- func (c *Client) DeleteSchemaMapping(ctx context.Context, params *DeleteSchemaMappingInput, ...) (*DeleteSchemaMappingOutput, error)
- func (c *Client) GetMatchId(ctx context.Context, params *GetMatchIdInput, optFns ...func(*Options)) (*GetMatchIdOutput, error)
- func (c *Client) GetMatchingJob(ctx context.Context, params *GetMatchingJobInput, optFns ...func(*Options)) (*GetMatchingJobOutput, error)
- func (c *Client) GetMatchingWorkflow(ctx context.Context, params *GetMatchingWorkflowInput, ...) (*GetMatchingWorkflowOutput, error)
- func (c *Client) GetSchemaMapping(ctx context.Context, params *GetSchemaMappingInput, optFns ...func(*Options)) (*GetSchemaMappingOutput, error)
- func (c *Client) ListMatchingJobs(ctx context.Context, params *ListMatchingJobsInput, optFns ...func(*Options)) (*ListMatchingJobsOutput, error)
- func (c *Client) ListMatchingWorkflows(ctx context.Context, params *ListMatchingWorkflowsInput, ...) (*ListMatchingWorkflowsOutput, error)
- func (c *Client) ListSchemaMappings(ctx context.Context, params *ListSchemaMappingsInput, optFns ...func(*Options)) (*ListSchemaMappingsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) StartMatchingJob(ctx context.Context, params *StartMatchingJobInput, optFns ...func(*Options)) (*StartMatchingJobOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateMatchingWorkflow(ctx context.Context, params *UpdateMatchingWorkflowInput, ...) (*UpdateMatchingWorkflowOutput, error)
- type CreateMatchingWorkflowInput
- type CreateMatchingWorkflowOutput
- type CreateSchemaMappingInput
- type CreateSchemaMappingOutput
- type DeleteMatchingWorkflowInput
- type DeleteMatchingWorkflowOutput
- type DeleteSchemaMappingInput
- type DeleteSchemaMappingOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetMatchIdInput
- type GetMatchIdOutput
- type GetMatchingJobInput
- type GetMatchingJobOutput
- type GetMatchingWorkflowInput
- type GetMatchingWorkflowOutput
- type GetSchemaMappingInput
- type GetSchemaMappingOutput
- type HTTPClient
- type HTTPSignerV4
- type ListMatchingJobsAPIClient
- type ListMatchingJobsInput
- type ListMatchingJobsOutput
- type ListMatchingJobsPaginator
- type ListMatchingJobsPaginatorOptions
- type ListMatchingWorkflowsAPIClient
- type ListMatchingWorkflowsInput
- type ListMatchingWorkflowsOutput
- type ListMatchingWorkflowsPaginator
- type ListMatchingWorkflowsPaginatorOptions
- type ListSchemaMappingsAPIClient
- type ListSchemaMappingsInput
- type ListSchemaMappingsOutput
- type ListSchemaMappingsPaginator
- type ListSchemaMappingsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- type StartMatchingJobInput
- type StartMatchingJobOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateMatchingWorkflowInput
- type UpdateMatchingWorkflowOutput
Constants ¶
const ServiceAPIVersion = "2018-05-10"
const ServiceID = "EntityResolution"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.1.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS EntityResolution.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateMatchingWorkflow ¶
func (c *Client) CreateMatchingWorkflow(ctx context.Context, params *CreateMatchingWorkflowInput, optFns ...func(*Options)) (*CreateMatchingWorkflowOutput, error)
Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.
func (*Client) CreateSchemaMapping ¶
func (c *Client) CreateSchemaMapping(ctx context.Context, params *CreateSchemaMappingInput, optFns ...func(*Options)) (*CreateSchemaMappingOutput, error)
Creates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.
func (*Client) DeleteMatchingWorkflow ¶
func (c *Client) DeleteMatchingWorkflow(ctx context.Context, params *DeleteMatchingWorkflowInput, optFns ...func(*Options)) (*DeleteMatchingWorkflowOutput, error)
Deletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.
func (*Client) DeleteSchemaMapping ¶
func (c *Client) DeleteSchemaMapping(ctx context.Context, params *DeleteSchemaMappingInput, optFns ...func(*Options)) (*DeleteSchemaMappingOutput, error)
Deletes the SchemaMapping with a given name. This operation will succeed even if a schema with the given name does not exist. This operation will fail if there is a DataIntegrationWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig .
func (*Client) GetMatchId ¶
func (c *Client) GetMatchId(ctx context.Context, params *GetMatchIdInput, optFns ...func(*Options)) (*GetMatchIdOutput, error)
Returns the corresponding Match ID of a customer record if the record has been processed.
func (*Client) GetMatchingJob ¶
func (c *Client) GetMatchingJob(ctx context.Context, params *GetMatchingJobInput, optFns ...func(*Options)) (*GetMatchingJobOutput, error)
Gets the status, metrics, and errors (if there are any) that are associated with a job.
func (*Client) GetMatchingWorkflow ¶
func (c *Client) GetMatchingWorkflow(ctx context.Context, params *GetMatchingWorkflowInput, optFns ...func(*Options)) (*GetMatchingWorkflowOutput, error)
Returns the MatchingWorkflow with a given name, if it exists.
func (*Client) GetSchemaMapping ¶
func (c *Client) GetSchemaMapping(ctx context.Context, params *GetSchemaMappingInput, optFns ...func(*Options)) (*GetSchemaMappingOutput, error)
Returns the SchemaMapping of a given name.
func (*Client) ListMatchingJobs ¶
func (c *Client) ListMatchingJobs(ctx context.Context, params *ListMatchingJobsInput, optFns ...func(*Options)) (*ListMatchingJobsOutput, error)
Lists all jobs for a given workflow.
func (*Client) ListMatchingWorkflows ¶
func (c *Client) ListMatchingWorkflows(ctx context.Context, params *ListMatchingWorkflowsInput, optFns ...func(*Options)) (*ListMatchingWorkflowsOutput, error)
Returns a list of all the MatchingWorkflows that have been created for an AWS account.
func (*Client) ListSchemaMappings ¶
func (c *Client) ListSchemaMappings(ctx context.Context, params *ListSchemaMappingsInput, optFns ...func(*Options)) (*ListSchemaMappingsOutput, error)
Returns a list of all the SchemaMappings that have been created for an AWS account.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Displays the tags associated with an AWS Entity Resolution resource. In Entity Resolution, SchemaMapping , and MatchingWorkflow can be tagged.
func (*Client) StartMatchingJob ¶
func (c *Client) StartMatchingJob(ctx context.Context, params *StartMatchingJobInput, optFns ...func(*Options)) (*StartMatchingJobOutput, error)
Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Entity Resolution, SchemaMapping , and MatchingWorkflow can be tagged. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes one or more tags from the specified AWS Entity Resolution resource. In Entity Resolution, SchemaMapping , and MatchingWorkflow can be tagged.
func (*Client) UpdateMatchingWorkflow ¶
func (c *Client) UpdateMatchingWorkflow(ctx context.Context, params *UpdateMatchingWorkflowInput, optFns ...func(*Options)) (*UpdateMatchingWorkflowOutput, error)
Updates an existing MatchingWorkflow . This method is identical to CreateMatchingWorkflow , except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must already exist for the method to succeed.
type CreateMatchingWorkflowInput ¶
type CreateMatchingWorkflowInput struct { // A list of InputSource objects, which have the fields InputSourceARN and // SchemaName . // // This member is required. InputSourceConfig []types.InputSource // A list of OutputSource objects, each of which contains fields OutputS3Path , // ApplyNormalization , and Output . // // This member is required. OutputSourceConfig []types.OutputSource // An object which defines the resolutionType and the ruleBasedProperties // // This member is required. ResolutionTechniques *types.ResolutionTechniques // The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes // this role to create resources on your behalf as part of workflow execution. // // This member is required. RoleArn *string // The name of the workflow. There cannot be multiple DataIntegrationWorkflows // with the same name. // // This member is required. WorkflowName *string // A description of the workflow. Description *string // An object which defines an incremental run type and has only incrementalRunType // as a field. IncrementalRunConfig *types.IncrementalRunConfig // The tags used to organize, track, or control access for this resource. Tags map[string]string // contains filtered or unexported fields }
type CreateMatchingWorkflowOutput ¶
type CreateMatchingWorkflowOutput struct { // A list of InputSource objects, which have the fields InputSourceARN and // SchemaName . // // This member is required. InputSourceConfig []types.InputSource // A list of OutputSource objects, each of which contains fields OutputS3Path , // ApplyNormalization , and Output . // // This member is required. OutputSourceConfig []types.OutputSource // An object which defines the resolutionType and the ruleBasedProperties // // This member is required. ResolutionTechniques *types.ResolutionTechniques // The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes // this role to create resources on your behalf as part of workflow execution. // // This member is required. RoleArn *string // 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 // A description of the workflow. Description *string // An object which defines an incremental run type and has only incrementalRunType // as a field. IncrementalRunConfig *types.IncrementalRunConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateSchemaMappingInput ¶
type CreateSchemaMappingInput struct { // The name of the schema. There cannot be multiple SchemaMappings with the same // name. // // This member is required. SchemaName *string // A description of the schema. Description *string // A list of MappedInputFields . Each MappedInputField corresponds to a column the // source data table, and contains column name plus additional information that // Entity Resolution uses for matching. MappedInputFields []types.SchemaInputAttribute // The tags used to organize, track, or control access for this resource. Tags map[string]string // contains filtered or unexported fields }
type CreateSchemaMappingOutput ¶
type CreateSchemaMappingOutput struct { // A description of the schema. // // This member is required. Description *string // A list of MappedInputFields . Each MappedInputField corresponds to a column the // source data table, and contains column name plus additional information that // Entity Resolution uses for matching. // // This member is required. MappedInputFields []types.SchemaInputAttribute // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteMatchingWorkflowInput ¶
type DeleteMatchingWorkflowInput struct { // The name of the workflow to be retrieved. // // This member is required. WorkflowName *string // contains filtered or unexported fields }
type DeleteMatchingWorkflowOutput ¶
type DeleteMatchingWorkflowOutput struct { // A successful operation message. // // This member is required. Message *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteSchemaMappingInput ¶
type DeleteSchemaMappingInput struct { // The name of the schema to delete. // // This member is required. SchemaName *string // contains filtered or unexported fields }
type DeleteSchemaMappingOutput ¶
type DeleteSchemaMappingOutput struct { // A successful operation message. // // This member is required. Message *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶ added in v1.1.0
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.1.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.1.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.1.0
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.1.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GetMatchIdInput ¶
type GetMatchIdOutput ¶
type GetMatchIdOutput struct { // The unique identifiers for this group of match records. MatchId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetMatchingJobInput ¶
type GetMatchingJobOutput ¶
type GetMatchingJobOutput 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 types.JobStatus // The time at which the job has finished. EndTime *time.Time // An object containing an error message, if there was an error. ErrorDetails *types.ErrorDetails // Metrics associated with the execution, specifically total records processed, // unique IDs generated, and records the execution skipped. Metrics *types.JobMetrics // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetMatchingWorkflowInput ¶
type GetMatchingWorkflowInput struct { // The name of the workflow. // // This member is required. WorkflowName *string // contains filtered or unexported fields }
type GetMatchingWorkflowOutput ¶
type GetMatchingWorkflowOutput struct { // The timestamp of when the workflow was created. // // This member is required. CreatedAt *time.Time // A list of InputSource objects, which have the fields InputSourceARN and // SchemaName . // // This member is required. InputSourceConfig []types.InputSource // A list of OutputSource objects, each of which contains fields OutputS3Path , // ApplyNormalization , and Output . // // This member is required. OutputSourceConfig []types.OutputSource // An object which defines the resolutionType and the ruleBasedProperties // // This member is required. ResolutionTechniques *types.ResolutionTechniques // The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes // this role to access resources on your behalf. // // This member is required. RoleArn *string // 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 // A description of the workflow. Description *string // An object which defines an incremental run type and has only incrementalRunType // as a field. IncrementalRunConfig *types.IncrementalRunConfig // The tags used to organize, track, or control access for this resource. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetSchemaMappingInput ¶
type GetSchemaMappingInput struct { // The name of the schema to be retrieved. // // This member is required. SchemaName *string // contains filtered or unexported fields }
type GetSchemaMappingOutput ¶
type GetSchemaMappingOutput struct { // The timestamp of when the SchemaMapping was created. // // This member is required. CreatedAt *time.Time // A list of MappedInputFields . Each MappedInputField corresponds to a column the // source data table, and contains column name plus additional information Venice // uses for matching. // // This member is required. MappedInputFields []types.SchemaInputAttribute // 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 // A description of the schema. Description *string // The tags used to organize, track, or control access for this resource. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type ListMatchingJobsAPIClient ¶
type ListMatchingJobsAPIClient interface {
ListMatchingJobs(context.Context, *ListMatchingJobsInput, ...func(*Options)) (*ListMatchingJobsOutput, error)
}
ListMatchingJobsAPIClient is a client that implements the ListMatchingJobs operation.
type ListMatchingJobsInput ¶
type ListMatchingJobsInput struct { // The name of the workflow to be retrieved. // // This member is required. WorkflowName *string // The maximum number of objects returned per page. MaxResults *int32 // The pagination token from the previous ListSchemaMappings API call. NextToken *string // contains filtered or unexported fields }
type ListMatchingJobsOutput ¶
type ListMatchingJobsOutput struct { // A list of JobSummary objects, each of which contain the ID, status, start time, // and end time of a job. Jobs []types.JobSummary // The pagination token from the previous ListSchemaMappings API call. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListMatchingJobsPaginator ¶
type ListMatchingJobsPaginator struct {
// contains filtered or unexported fields
}
ListMatchingJobsPaginator is a paginator for ListMatchingJobs
func NewListMatchingJobsPaginator ¶
func NewListMatchingJobsPaginator(client ListMatchingJobsAPIClient, params *ListMatchingJobsInput, optFns ...func(*ListMatchingJobsPaginatorOptions)) *ListMatchingJobsPaginator
NewListMatchingJobsPaginator returns a new ListMatchingJobsPaginator
func (*ListMatchingJobsPaginator) HasMorePages ¶
func (p *ListMatchingJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListMatchingJobsPaginator) NextPage ¶
func (p *ListMatchingJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMatchingJobsOutput, error)
NextPage retrieves the next ListMatchingJobs page.
type ListMatchingJobsPaginatorOptions ¶
type ListMatchingJobsPaginatorOptions struct { // The maximum number of objects returned per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListMatchingJobsPaginatorOptions is the paginator options for ListMatchingJobs
type ListMatchingWorkflowsAPIClient ¶
type ListMatchingWorkflowsAPIClient interface {
ListMatchingWorkflows(context.Context, *ListMatchingWorkflowsInput, ...func(*Options)) (*ListMatchingWorkflowsOutput, error)
}
ListMatchingWorkflowsAPIClient is a client that implements the ListMatchingWorkflows operation.
type ListMatchingWorkflowsOutput ¶
type ListMatchingWorkflowsOutput struct { // The pagination token from the previous ListSchemaMappings API call. NextToken *string // A list of MatchingWorkflowSummary objects, each of which contain the fields // WorkflowName , WorkflowArn , CreatedAt , and UpdatedAt . WorkflowSummaries []types.MatchingWorkflowSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListMatchingWorkflowsPaginator ¶
type ListMatchingWorkflowsPaginator struct {
// contains filtered or unexported fields
}
ListMatchingWorkflowsPaginator is a paginator for ListMatchingWorkflows
func NewListMatchingWorkflowsPaginator ¶
func NewListMatchingWorkflowsPaginator(client ListMatchingWorkflowsAPIClient, params *ListMatchingWorkflowsInput, optFns ...func(*ListMatchingWorkflowsPaginatorOptions)) *ListMatchingWorkflowsPaginator
NewListMatchingWorkflowsPaginator returns a new ListMatchingWorkflowsPaginator
func (*ListMatchingWorkflowsPaginator) HasMorePages ¶
func (p *ListMatchingWorkflowsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListMatchingWorkflowsPaginator) NextPage ¶
func (p *ListMatchingWorkflowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMatchingWorkflowsOutput, error)
NextPage retrieves the next ListMatchingWorkflows page.
type ListMatchingWorkflowsPaginatorOptions ¶
type ListMatchingWorkflowsPaginatorOptions struct { // The maximum number of objects returned per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListMatchingWorkflowsPaginatorOptions is the paginator options for ListMatchingWorkflows
type ListSchemaMappingsAPIClient ¶
type ListSchemaMappingsAPIClient interface {
ListSchemaMappings(context.Context, *ListSchemaMappingsInput, ...func(*Options)) (*ListSchemaMappingsOutput, error)
}
ListSchemaMappingsAPIClient is a client that implements the ListSchemaMappings operation.
type ListSchemaMappingsInput ¶
type ListSchemaMappingsOutput ¶
type ListSchemaMappingsOutput struct { // The pagination token from the previous ListDomains API call. NextToken *string // A list of SchemaMappingSummary objects, each of which contain the fields // SchemaName , SchemaArn , CreatedAt , UpdatedAt . SchemaList []types.SchemaMappingSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListSchemaMappingsPaginator ¶
type ListSchemaMappingsPaginator struct {
// contains filtered or unexported fields
}
ListSchemaMappingsPaginator is a paginator for ListSchemaMappings
func NewListSchemaMappingsPaginator ¶
func NewListSchemaMappingsPaginator(client ListSchemaMappingsAPIClient, params *ListSchemaMappingsInput, optFns ...func(*ListSchemaMappingsPaginatorOptions)) *ListSchemaMappingsPaginator
NewListSchemaMappingsPaginator returns a new ListSchemaMappingsPaginator
func (*ListSchemaMappingsPaginator) HasMorePages ¶
func (p *ListSchemaMappingsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSchemaMappingsPaginator) NextPage ¶
func (p *ListSchemaMappingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSchemaMappingsOutput, error)
NextPage retrieves the next ListSchemaMappings page.
type ListSchemaMappingsPaginatorOptions ¶
type ListSchemaMappingsPaginatorOptions struct { // The maximum number of objects returned per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListSchemaMappingsPaginatorOptions is the paginator options for ListSchemaMappings
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The ARN of the resource for which you want to view tags. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The tags used to organize, track, or control access for this resource. // // This member is required. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom // endpoint, set the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service. This should be used over // the deprecated EndpointResolver EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type StartMatchingJobInput ¶
type StartMatchingJobInput struct { // The name of the matching job to be retrieved. // // This member is required. WorkflowName *string // contains filtered or unexported fields }
type StartMatchingJobOutput ¶
type StartMatchingJobOutput struct { // The ID of the job. // // This member is required. JobId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceInput struct { // The ARN of the resource for which you want to view tags. // // This member is required. ResourceArn *string // The tags used to organize, track, or control access for this resource. // // This member is required. Tags map[string]string // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateMatchingWorkflowInput ¶
type UpdateMatchingWorkflowInput struct { // A list of InputSource objects, which have the fields InputSourceARN and // SchemaName . // // This member is required. InputSourceConfig []types.InputSource // A list of OutputSource objects, each of which contains fields OutputS3Path , // ApplyNormalization , and Output . // // This member is required. OutputSourceConfig []types.OutputSource // An object which defines the resolutionType and the ruleBasedProperties // // This member is required. ResolutionTechniques *types.ResolutionTechniques // The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes // this role to create resources on your behalf as part of workflow execution. // // This member is required. RoleArn *string // The name of the workflow to be retrieved. // // This member is required. WorkflowName *string // A description of the workflow. Description *string // An object which defines an incremental run type and has only incrementalRunType // as a field. IncrementalRunConfig *types.IncrementalRunConfig // contains filtered or unexported fields }
type UpdateMatchingWorkflowOutput ¶
type UpdateMatchingWorkflowOutput struct { // A list of InputSource objects, which have the fields InputSourceARN and // SchemaName . // // This member is required. InputSourceConfig []types.InputSource // A list of OutputSource objects, each of which contains fields OutputS3Path , // ApplyNormalization , and Output . // // This member is required. OutputSourceConfig []types.OutputSource // An object which defines the resolutionType and the ruleBasedProperties // // This member is required. ResolutionTechniques *types.ResolutionTechniques // The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes // this role to create resources on your behalf as part of workflow execution. // // This member is required. RoleArn *string // The name of the workflow. // // This member is required. WorkflowName *string // A description of the workflow. Description *string // An object which defines an incremental run type and has only incrementalRunType // as a field. IncrementalRunConfig *types.IncrementalRunConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_CreateMatchingWorkflow.go
- api_op_CreateSchemaMapping.go
- api_op_DeleteMatchingWorkflow.go
- api_op_DeleteSchemaMapping.go
- api_op_GetMatchId.go
- api_op_GetMatchingJob.go
- api_op_GetMatchingWorkflow.go
- api_op_GetSchemaMapping.go
- api_op_ListMatchingJobs.go
- api_op_ListMatchingWorkflows.go
- api_op_ListSchemaMappings.go
- api_op_ListTagsForResource.go
- api_op_StartMatchingJob.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateMatchingWorkflow.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- serializers.go
- validators.go