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

GetRecommenderSchema

Retrieves information about a specific recommender schema in a domain.

Request Syntax


GET /domains/DomainName/recommender-schemas/RecommenderSchemaName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

RecommenderSchemaName

The name of the recommender schema to retrieve.

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

Pattern: ^[a-zA-Z0-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,
   "Fields": { 
      "string" : [ 
         { 
            "ContentType": "string",
            "FeatureType": "string",
            "TargetFieldName": "string"
         }
      ]
   },
   "RecommenderSchemaName": "string",
   "Status": "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.

CreatedAt

The timestamp of when the recommender schema was created.

Type: Timestamp

Fields

A map of dataset type to column definitions included in the schema.

Type: String to array of RecommenderSchemaField objects map

Map Entries: Maximum number of 1 item.

Array Members: Minimum number of 1 item. Maximum number of 9 items.

RecommenderSchemaName

The name of the recommender schema.

Type: String

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

Pattern: ^[a-zA-Z0-9_-]+$

Status

The status of the recommender schema.

Type: String

Valid Values: ACTIVE | DELETING

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

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429