provider_services

Creates, updates, deletes, gets or lists a provider_services resource.

Overview

Name	provider_services
Type	Resource
Id	aws.entityresolution.provider_services

Fields

The following fields are returned by SELECT queries:

get_provider_service

Name	Datatype	Description
anonymized_output	boolean	Specifies whether output data from the provider is anonymized. A value of TRUE means the output will be anonymized and you can't relate the data that comes back from the provider to the identifying input. A value of FALSE means the output won't be anonymized and you can relate the data that comes back from the provider to your source data.
provider_component_schema	object	Input schema for the provider service.
provider_configuration_definition	object	The definition of the provider configuration.
provider_endpoint_configuration	object	The required configuration fields to use with the provider service.
provider_entity_output_definition	object	The definition of the provider entity output.
provider_id_name_space_configuration	object	The provider configuration required for different ID namespace types.
provider_intermediate_data_access_configuration	object	The Amazon Web Services accounts and the S3 permissions that are required by some providers to create an S3 bucket for intermediate data storage.
provider_job_configuration	object	Provider service job configurations.
provider_name	string	The name of the provider. This name is typically the company name. (pattern: <code>[a-zA-Z_0-9-]*</code>)
provider_service_arn	string	The ARN (Amazon Resource Name) that Entity Resolution generated for the provider service. (pattern: <code>arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})</code>)
provider_service_display_name	string	The display name of the provider service.
provider_service_name	string	The name of the product that the provider service provides. (pattern: <code>[a-zA-Z_0-9-]*</code>)
provider_service_type	string	The type of provider service. (ASSIGNMENT, ID_MAPPING)

list_provider_services

Name	Datatype	Description
provider_name	string	The name of the provider. This name is typically the company name. (pattern: <code>[a-zA-Z_0-9-]*</code>)
provider_service_arn	string	The ARN (Amazon Resource Name) that Entity Resolution generated for the providerService. (pattern: <code>arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})</code>)
provider_service_display_name	string	The display name of the provider service.
provider_service_name	string	The name of the product that the provider service provides. (pattern: <code>[a-zA-Z_0-9-]*</code>)
provider_service_type	string	The type of provider service. (ASSIGNMENT, ID_MAPPING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_provider_service	select	provider_name, provider_service_name, region		Returns the ProviderService of a given name.
list_provider_services	select	region	nextToken, maxResults, providerName	Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
provider_name	string	The name of the provider. This name is typically the company name.
provider_service_name	string	The ARN (Amazon Resource Name) of the product that the provider service provides.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of objects returned per page.
nextToken	string	The pagination token from the previous API call.
providerName	string	The name of the provider. This name is typically the company name.

SELECT examples

get_provider_service

Returns the ProviderService of a given name.

SELECT
anonymized_output,
provider_component_schema,
provider_configuration_definition,
provider_endpoint_configuration,
provider_entity_output_definition,
provider_id_name_space_configuration,
provider_intermediate_data_access_configuration,
provider_job_configuration,
provider_name,
provider_service_arn,
provider_service_display_name,
provider_service_name,
provider_service_type
FROM aws.entityresolution.provider_services
WHERE provider_name = '{{ provider_name }}' -- required
AND provider_service_name = '{{ provider_service_name }}' -- required
AND region = '{{ region }}' -- required
;

list_provider_services

Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.

SELECT
provider_name,
provider_service_arn,
provider_service_display_name,
provider_service_name,
provider_service_type
FROM aws.entityresolution.provider_services
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND providerName = '{{ providerName }}'
;