ParametersResponseBody

pydantic model openapi_client.models.parameters_response_body.ParametersResponseBody

ParametersResponseBody

Fields:
field parameter_key: Optional[StrictStr] = None (alias 'ParameterKey')

Full stored key, typically /adp/amorphic/pstore/{Scope}/{name}.

field display_name: Optional[StrictStr] = None (alias 'DisplayName')

Last path segment of ParameterKey, or the key with /adp/amorphic/ stripped for system keys.

field parameter_value: Optional[StrictStr] = None (alias 'ParameterValue')

Decrypted value from SSM (SecureString values are not stored in DynamoDB metadata)

field parameter_type: Optional[StrictStr] = None (alias 'ParameterType')

SSM type. String, StringList, or SecureString. Cannot change after create.

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

Human-readable description stored in DynamoDB.

field scope: Optional[StrictStr] = None (alias 'Scope')

global is shared (managers control updates). user is private to the owner and ACL editors. Cannot change after create.

field owner: Optional[StrictStr] = None (alias 'Owner')

Parameter owner user ID, or global/System for shared/system parameters.

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

User ID that created the parameter.

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

Create timestamp in UTC, format %Y-%m-%d %H:%M:%S.

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

User ID that last updated the parameter.

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

Last update timestamp in UTC, format %Y-%m-%d %H:%M:%S.

field tenant_name: Optional[StrictStr] = None (alias 'TenantName')

Optional tenant used when multi-tenant Redshift is enabled.

field new_convention: Optional[StrictBool] = None (alias 'NewConvention')

True when ParameterKey starts with /adp/amorphic; otherwise false.

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

Present for user-scoped parameters. Caller’s ACL: owner, editor, or read-only.

field parameter_managers: Optional[List[StrictStr]] = None (alias 'ParameterManagers')

Global-scope user IDs allowed to update the parameter. Empty list means legacy open update.

field code_repository: Optional[ParametersResponseBodyCodeRepository] = None (alias 'CodeRepository')
field ownership_type: Optional[StrictStr] = None (alias 'OwnershipType')

Present when Owner is global. owner is the creator, manager is in ParameterManagers, user is any other authorized caller.

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

Return type:

Optional[Self]