UserAgreementListItem

pydantic model openapi_client.models.user_agreement_list_item.UserAgreementListItem

One DynamoDB user agreement item. Partition key AgreementName. GSI hash key Version. No S3PresignedUrl on the list endpoint.

Fields:

• agreement_name (str | None)

• created_by (str | None)

• creation_time (str | None)

• description (str | None)

• s3_path (str | None)

• version (str | None)

field agreement_name: Optional[StrictStr] = None (alias 'AgreementName')

Unique name. 3-120 alphanumeric and underscore characters starting with a letter (validate_name for User Agreement).

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

Stored as submitted. Empty string is allowed. Defaults to N/A only when the key is absent, which POST rejects with IPV-1008.

field version: Optional[StrictStr] = None (alias 'Version')

Unix epoch seconds as a decimal string.

field s3_path: Optional[StrictStr] = None (alias 'S3Path')

s3://{miscBucket}/user-agreements/{Version}.md

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

Creating user id.

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')

commonUtil.get_current_time() at create.

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 UserAgreementListItem 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 UserAgreementListItem from a dict

Return type:

Optional[Self]