GetProviderService
Returns the ProviderService of a given name.
Request Syntax
GET /providerservices/providerName/providerServiceName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- providerName
-
The name of the provider. This name is typically the company name.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z_0-9-]*Required: Yes
- providerServiceName
-
The ARN (Amazon Resource Name) of the product that the provider service provides.
Length Constraints: Minimum length of 20. Maximum length of 255.
Pattern:
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})Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"anonymizedOutput": boolean,
"providerComponentSchema": {
"providerSchemaAttributes": [
{
"fieldName": "string",
"hashing": boolean,
"subType": "string",
"type": "string"
}
],
"schemas": [
[ "string" ]
]
},
"providerConfigurationDefinition": JSON value,
"providerEndpointConfiguration": { ... },
"providerEntityOutputDefinition": JSON value,
"providerIdNameSpaceConfiguration": {
"description": "string",
"providerSourceConfigurationDefinition": JSON value,
"providerTargetConfigurationDefinition": JSON value
},
"providerIntermediateDataAccessConfiguration": {
"awsAccountIds": [ "string" ],
"requiredBucketActions": [ "string" ]
},
"providerJobConfiguration": JSON value,
"providerName": "string",
"providerServiceArn": "string",
"providerServiceDisplayName": "string",
"providerServiceName": "string",
"providerServiceType": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- anonymizedOutput
-
Specifies whether output data from the provider is anonymized. A value of
TRUEmeans the output will be anonymized and you can't relate the data that comes back from the provider to the identifying input. A value ofFALSEmeans the output won't be anonymized and you can relate the data that comes back from the provider to your source data.Type: Boolean
- providerComponentSchema
-
Input schema for the provider service.
Type: ProviderComponentSchema object
- providerConfigurationDefinition
-
The definition of the provider configuration.
Type: JSON value
- providerEndpointConfiguration
-
The required configuration fields to use with the provider service.
Type: ProviderEndpointConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
- providerEntityOutputDefinition
-
The definition of the provider entity output.
Type: JSON value
- providerIdNameSpaceConfiguration
-
The provider configuration required for different ID namespace types.
Type: ProviderIdNameSpaceConfiguration object
- providerIntermediateDataAccessConfiguration
-
The AWS accounts and the S3 permissions that are required by some providers to create an S3 bucket for intermediate data storage.
Type: ProviderIntermediateDataAccessConfiguration object
- providerJobConfiguration
-
Provider service job configurations.
Type: JSON value
- providerName
-
The name of the provider. This name is typically the company name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z_0-9-]* - providerServiceArn
-
The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the provider service.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 255.
Pattern:
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}) - providerServiceDisplayName
-
The display name of the provider service.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
- providerServiceName
-
The name of the product that the provider service provides.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z_0-9-]* - providerServiceType
-
The type of provider service.
Type: String
Valid Values:
ASSIGNMENT | ID_MAPPING
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
