RemoveSchemaVersionMetadata - AWS Glue

RemoveSchemaVersionMetadata

Removes a key value pair from the schema version metadata for the specified schema version ID.

Request Syntax

{ "MetadataKeyValue": { "MetadataKey": "string", "MetadataValue": "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.

MetadataKeyValue

The value of the metadata key.

Type: MetadataKeyValuePair object

Required: Yes

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

{ "LatestVersion": boolean, "MetadataKey": "string", "MetadataValue": "string", "RegistryName": "string", "SchemaArn": "string", "SchemaName": "string", "SchemaVersionId": "string", "VersionNumber": 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.

LatestVersion

The latest version of the schema.

Type: Boolean

MetadataKey

The metadata key.

Type: String

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

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

MetadataValue

The value of the metadata key.

Type: String

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

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

RegistryName

The name of the registry.

Type: String

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

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

SchemaArn

The Amazon Resource Name (ARN) of the schema.

Type: String

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

Pattern: arn:aws:glue:.*

SchemaName

The name of the schema.

Type: String

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

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

SchemaVersionId

The version ID for 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}

VersionNumber

The version number of the schema.

Type: Long

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

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: