[ aws . schemas ]

update-schema

Description

Updates the schema definition

Note

Inactive schemas will be deleted after two years.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-schema
[--client-token-id <value>]
[--content <value>]
[--description <value>]
--registry-name <value>
--schema-name <value>
[--type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--client-token-id (string)

The ID of the client token.

--content (string)

The source of the schema definition.

--description (string)

The description of the schema.

--registry-name (string)

The name of the registry.

--schema-name (string)

The name of the schema.

--type (string)

The schema type for the events schema.

Possible values:

• OpenApi3

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

Description -> (string)

The description of the schema.

LastModified -> (timestamp)

The date and time that schema was modified.

SchemaArn -> (string)

The ARN of the schema.

SchemaName -> (string)

The name of the schema.

SchemaVersion -> (string)

The version number of the schema

Tags -> (map)

Key-value pairs associated with a resource.

key -> (string)

value -> (string)

Type -> (string)

The type of the schema.

VersionCreatedDate -> (timestamp)

The date the schema version was created.