QuerySchemaVersionMetadata - AWS Glue

QuerySchemaVersionMetadata

Queries for the schema version metadata information.

Request Syntax

{ "MaxResults": number, "MetadataList": [ { "MetadataKey": "string", "MetadataValue": "string" } ], "NextToken": "string", "SchemaId": { "RegistryName": "string", "SchemaArn": "string", "SchemaName": "string" }, "SchemaVersionId": "string", "SchemaVersionNumber": { "LatestVersion": boolean, "VersionNumber": number } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

MetadataList

Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.

Type: Array of MetadataKeyValuePair objects

Required: No

NextToken

A continuation token, if this is a continuation call.

Type: String

Required: No

SchemaId

A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).

Type: SchemaId object

Required: No

SchemaVersionId

The unique version ID of the schema version.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: No

SchemaVersionNumber

The version number of the schema.

Type: SchemaVersionNumber object

Required: No

Response Syntax

{ "MetadataInfoMap": { "string" : { "CreatedTime": "string", "MetadataValue": "string" } }, "NextToken": "string", "SchemaVersionId": "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.

MetadataInfoMap

A map of a metadata key and associated values.

Type: String to MetadataInfo object map

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

Key Pattern: [a-zA-Z0-9+-=._./@]+

NextToken

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Type: String

SchemaVersionId

The unique version ID of the schema version.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Errors

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

AccessDeniedException

Access to a resource was denied.

HTTP Status Code: 400

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

See Also

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