[ aws . apigatewayv2 ]

get-model

Description

Gets a Model.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-model
--api-id <value>
--model-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The API identifier.

--model-id (string)

The model ID.

--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.

See ‘aws help’ for descriptions of global parameters.

Output

ContentType -> (string)

The content-type for the model, for example, “application/json”.

Description -> (string)

The description of the model.

ModelId -> (string)

The model identifier.

Name -> (string)

The name of the model. Must be alphanumeric.

Schema -> (string)

The schema for the model. For application/json models, this should be JSON schema draft 4 model.