APIGateway / Client / create_model

create_model#

APIGateway.Client.create_model(**kwargs)#

Adds a new Model resource to an existing RestApi resource.

See also: AWS API Documentation

Request Syntax

response = client.create_model(
    restApiId='string',
    name='string',
    description='string',
    schema='string',
    contentType='string'
)
Parameters:

  • restApiId (string) –

    [REQUIRED]

    The RestApi identifier under which the Model will be created.

  • name (string) –

    [REQUIRED]

    The name of the model. Must be alphanumeric.

  • description (string) – The description of the model.

  • schema (string) – The schema for the model. For application/json models, this should be JSON schema draft 4 model. The maximum size of the model is 400 KB.

  • contentType (string) –

    [REQUIRED]

    The content-type for the model.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'description': 'string',
    'schema': 'string',
    'contentType': 'string'
}

Response Structure

  • (dict) –

    Represents the data structure of a method’s request or response payload.

    • id (string) –

      The identifier for the model resource.

    • name (string) –

      The name of the model. Must be an alphanumeric string.

    • description (string) –

      The description of the model.

    • schema (string) –

      The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include “*/” characters in the description of any properties because such “*/” characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API’s SDK generated by API Gateway to fail.

    • contentType (string) –

      The content-type for the model.

Exceptions