braket.jobs_data.persisted_job_data_v1 module

class braket.jobs_data.persisted_job_data_v1.PersistedJobDataFormat(value)[source]

Bases: str, Enum

Enum class for the the required formats.

PLAINTEXT = 'plaintext'

PICKLED_V4 = 'pickled_v4'

class braket.jobs_data.persisted_job_data_v1.PersistedJobData(*, braketSchemaHeader: BraketSchemaHeader = BraketSchemaHeader(name='braket.jobs_data.persisted_job_data', version='1'), dataDictionary: Dict[str, Any], dataFormat: PersistedJobDataFormat | str)[source]

Bases: BraketSchemaBase

The schema used for persisting data during Amazon Braket job executions.

braketSchemaHeader

Schema header. Users do not need to set this value.

Type:: BraketSchemaHeader

dataDictionary

Dict representing the data to be persisted.

Type:: Dict[str, Any]

dataFormat

Data format used for persisting the values in dataDictionary.

Type:: Union[PersistedJobDataFormat, str]

Examples

>>> data_to_persist = {"some_key": "some_value", "more_keys": True}
>>> PersistedJobData(dataDictionary=data_to_persist,
>>>                  dataFormat=PersistedJobDataFormat.PLAINTEXT)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

braketSchemaHeader: BraketSchemaHeader

dataDictionary: Dict[str, Any]

dataFormat: PersistedJobDataFormat | str