ModelPutData

pydantic model openapi_client.models.model_put_data.ModelPutData

Metadata fields accepted on PUT /models/{model_id}. AlgorithmUsed must be present because the handler always reads it, but the stored algorithm is not changed. ArtifactsLocation and AccessType in the body are ignored.

Fields:
field description: Optional[StrictStr] = None (alias 'Description')

Updated description.

field model_name: Optional[StrictStr] = None (alias 'ModelName')

Updated unique display name. Duplicate names return IPV-1018.

field output_type: Optional[StrictStr] = None (alias 'OutputType')

Updated output type. datasetdata keeps or applies schemas; any other value forces schemas to N/A.

field algorithm_used: Optional[StrictStr] = None (alias 'AlgorithmUsed')

Must be included in the body. The value is never written to DynamoDB - the stored algorithm is retained - but the handler reads it unconditionally, so omitting it returns 500 GE-1008.

field supported_file_formats: Optional[List[StrictStr]] = None (alias 'SupportedFileFormats')

Updated accepted file formats.

field pre_processed_glue_jobs: Optional[StrictStr] = None (alias 'PreProcessedGlueJobs')

Updated pre-processing Glue job name.

field post_processed_glue_jobs: Optional[StrictStr] = None (alias 'PostProcessedGlueJobs')

Updated post-processing Glue job name.

field keywords: Optional[List[StrictStr]] = None (alias 'Keywords')

Updated free-form tags.

field artifacts_location: Optional[StrictStr] = None (alias 'ArtifactsLocation')

Accepted in the body but not applied on update.

field access_type: Optional[StrictStr] = None (alias 'AccessType')

Accepted in the body but not applied on update.

field input_schema: Optional[ModelPutDataInputSchema] = None (alias 'InputSchema')
field output_schema: Optional[ModelPutDataOutputSchema] = None (alias 'OutputSchema')
to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of ModelPutData from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of ModelPutData from a dict

Return type:

Optional[Self]