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

GetSchemaMapping

Returns the SchemaMapping of a given name.

Request Syntax


GET /schemas/schemaName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

schemaName

The name of the schema to be retrieved.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_0-9-]*$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "description": "string",
   "hasWorkflows": boolean,
   "mappedInputFields": [ 
      { 
         "fieldName": "string",
         "groupName": "string",
         "hashed": boolean,
         "matchKey": "string",
         "subType": "string",
         "type": "string"
      }
   ],
   "schemaArn": "string",
   "schemaName": "string",
   "tags": { 
      "string" : "string" 
   },
   "updatedAt": number
}

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.

createdAt

The timestamp of when the SchemaMapping was created.

Type: Timestamp

description

A description of the schema.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

hasWorkflows

Specifies whether the schema mapping has been applied to a workflow.

Type: Boolean

mappedInputFields

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.

Type: Array of SchemaInputAttribute objects

Array Members: Minimum number of 2 items. Maximum number of 35 items.

schemaArn

The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping.

Type: String

Pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(schemamapping/[a-zA-Z_0-9-]{1,255})$

schemaName

The name of the schema.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_0-9-]*$

tags

The tags used to organize, track, or control access for this resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

updatedAt

The timestamp of when the SchemaMapping was last updated.

Type: Timestamp

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