Skip to main content
GET
Get schema
Required scope: schemas:read

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /v1/auth/token. Pass in the Authorization header as Bearer <token>.

Path Parameters

schemaName
string
required

The schema name to retrieve.

Response

Schema record.

success
boolean
required

true when the request was processed without errors, false otherwise. Always present.

data
object

A DynamoSQL schema record. A schema connects a logical name to the IAM role and AWS region DynamoSQL uses to access DynamoDB on your behalf via cross-account role assumption.

error
object

Present in the response body when success is false.