ApiGatewayV2 / Client / get_model

get_model#

ApiGatewayV2.Client.get_model(**kwargs)#

Gets a Model.

See also: AWS API Documentation

Request Syntax

response = client.get_model(
    ApiId='string',
    ModelId='string'
)

Parameters:

ApiId (string) –
[REQUIRED]

The API identifier.
ModelId (string) –
[REQUIRED]

The model ID.

Return type:

dict

Returns:

Response Syntax

{
    'ContentType': 'string',
    'Description': 'string',
    'ModelId': 'string',
    'Name': 'string',
    'Schema': 'string'
}

Response Structure

(dict) –

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

Exceptions