BatchGetRecord - Amazon SageMaker
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

BatchGetRecord

Retrieves a batch of Records from a FeatureGroup.

Request Syntax

POST /BatchGetRecord HTTP/1.1
Content-type: application/json

{
   "ExpirationTimeResponse": "string",
   "Identifiers": [ 
      { 
         "FeatureGroupName": "string",
         "FeatureNames": [ "string" ],
         "RecordIdentifiersValueAsString": [ "string" ]
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ExpirationTimeResponse

Parameter to request ExpiresAt in response. If Enabled, BatchGetRecord will return the value of ExpiresAt, if it is not null. If Disabled and null, BatchGetRecord will return null.

Type: String

Valid Values: Enabled | Disabled

Required: No

Identifiers

A list containing the name or Amazon Resource Name (ARN) of the FeatureGroup, the list of names of Features to be retrieved, and the corresponding RecordIdentifier values as strings.

Type: Array of BatchGetRecordIdentifier objects

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

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "Errors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "FeatureGroupName": "string",
         "RecordIdentifierValueAsString": "string"
      }
   ],
   "Records": [ 
      { 
         "ExpiresAt": "string",
         "FeatureGroupName": "string",
         "Record": [ 
            { 
               "FeatureName": "string",
               "ValueAsString": "string",
               "ValueAsStringList": [ "string" ]
            }
         ],
         "RecordIdentifierValueAsString": "string"
      }
   ],
   "UnprocessedIdentifiers": [ 
      { 
         "FeatureGroupName": "string",
         "FeatureNames": [ "string" ],
         "RecordIdentifiersValueAsString": [ "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.

Errors

A list of errors that have occurred when retrieving a batch of Records.

Type: Array of BatchGetRecordError objects

Array Members: Minimum number of 0 items.

Records

A list of Records you requested to be retrieved in batch.

Type: Array of BatchGetRecordResultDetail objects

Array Members: Minimum number of 0 items.

UnprocessedIdentifiers

A unprocessed list of FeatureGroup names, with their corresponding RecordIdentifier value, and Feature name.

Type: Array of BatchGetRecordIdentifier objects

Array Members: Minimum number of 0 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessForbidden

You do not have permission to perform an action.

HTTP Status Code: 403

InternalFailure

An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.

HTTP Status Code: 500

ServiceUnavailable

The service is currently unavailable.

HTTP Status Code: 503

ValidationError

There was an error validating your request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: