EntityResolution / Client / get_provider_service

get_provider_service#

EntityResolution.Client.get_provider_service(**kwargs)#

Returns the ProviderService of a given name.

See also: AWS API Documentation

Request Syntax

response = client.get_provider_service(
    providerName='string',
    providerServiceName='string'
)
Parameters:

  • providerName (string) –

    [REQUIRED]

    The name of the provider. This name is typically the company name.

  • providerServiceName (string) –

    [REQUIRED]

    The ARN (Amazon Resource Name) of the product that the provider service provides.

Return type:

dict

Returns:

Response Syntax

{
    'anonymizedOutput': True|False,
    'providerComponentSchema': {
        'providerSchemaAttributes': [
            {
                'fieldName': 'string',
                'hashing': True|False,
                'subType': 'string',
                'type': 'NAME'|'NAME_FIRST'|'NAME_MIDDLE'|'NAME_LAST'|'ADDRESS'|'ADDRESS_STREET1'|'ADDRESS_STREET2'|'ADDRESS_STREET3'|'ADDRESS_CITY'|'ADDRESS_STATE'|'ADDRESS_COUNTRY'|'ADDRESS_POSTALCODE'|'PHONE'|'PHONE_NUMBER'|'PHONE_COUNTRYCODE'|'EMAIL_ADDRESS'|'UNIQUE_ID'|'DATE'|'STRING'|'PROVIDER_ID'
            },
        ],
        'schemas': [
            [
                'string',
            ],
        ]
    },
    'providerConfigurationDefinition': {...}|[...]|123|123.4|'string'|True|None,
    'providerEndpointConfiguration': {
        'marketplaceConfiguration': {
            'assetId': 'string',
            'dataSetId': 'string',
            'listingId': 'string',
            'revisionId': 'string'
        }
    },
    'providerEntityOutputDefinition': {...}|[...]|123|123.4|'string'|True|None,
    'providerIdNameSpaceConfiguration': {
        'description': 'string',
        'providerSourceConfigurationDefinition': {...}|[...]|123|123.4|'string'|True|None,
        'providerTargetConfigurationDefinition': {...}|[...]|123|123.4|'string'|True|None
    },
    'providerIntermediateDataAccessConfiguration': {
        'awsAccountIds': [
            'string',
        ],
        'requiredBucketActions': [
            'string',
        ]
    },
    'providerJobConfiguration': {...}|[...]|123|123.4|'string'|True|None,
    'providerName': 'string',
    'providerServiceArn': 'string',
    'providerServiceDisplayName': 'string',
    'providerServiceName': 'string',
    'providerServiceType': 'ASSIGNMENT'|'ID_MAPPING'
}

Response Structure

  • (dict) –

    • anonymizedOutput (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.

    • providerComponentSchema (dict) –

      Input schema for the provider service.

      • providerSchemaAttributes (list) –

        The provider schema attributes.

        • (dict) –

          The provider schema attribute.

          • fieldName (string) –

            The field name.

          • hashing (boolean) –

            The hashing attribute of the provider schema.

          • subType (string) –

            The sub type of the provider schema attribute.

          • type (string) –

            The type of the provider schema attribute.

      • schemas (list) –

        Input schema for the provider service.

        • (list) –

          • (string) –

    • providerConfigurationDefinition (document) –

      The definition of the provider configuration.

    • providerEndpointConfiguration (dict) –

      The required configuration fields to use with the provider service.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: marketplaceConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • marketplaceConfiguration (dict) –

        The identifiers of the provider service, from Data Exchange.

        • assetId (string) –

          The asset ID on Data Exchange.

        • dataSetId (string) –

          The dataset ID on Data Exchange.

        • listingId (string) –

          The listing ID on Data Exchange.

        • revisionId (string) –

          The revision ID on Data Exchange.

    • providerEntityOutputDefinition (document) –

      The definition of the provider entity output.

    • providerIdNameSpaceConfiguration (dict) –

      The provider configuration required for different ID namespace types.

      • description (string) –

        The description of the ID namespace.

      • providerSourceConfigurationDefinition (document) –

        Configurations required for the source ID namespace.

      • providerTargetConfigurationDefinition (document) –

        Configurations required for the target ID namespace.

    • providerIntermediateDataAccessConfiguration (dict) –

      The Amazon Web Services accounts and the S3 permissions that are required by some providers to create an S3 bucket for intermediate data storage.

      • awsAccountIds (list) –

        The Amazon Web Services account that provider can use to read or write data into the customer’s intermediate S3 bucket.

        • (string) –

      • requiredBucketActions (list) –

        The S3 bucket actions that the provider requires permission for.

        • (string) –

    • providerJobConfiguration (document) –

      Provider service job configurations.

    • providerName (string) –

      The name of the provider. This name is typically the company name.

    • providerServiceArn (string) –

      The ARN (Amazon Resource Name) that Entity Resolution generated for the provider service.

    • providerServiceDisplayName (string) –

      The display name of the provider service.

    • providerServiceName (string) –

      The name of the product that the provider service provides.

    • providerServiceType (string) –

      The type of provider service.

Exceptions