Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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

Type: Boolean

providerComponentSchema