CompleteRegistration

pydantic model openapi_client.models.complete_registration.CompleteRegistration

Request body for complete_dataset_registration. DatasetSchema is always required. Other fields are conditionally required based on the dataset’s TargetLocation and TableUpdate mode.

Fields:

• are_auto_constraint_suggestions_enabled (bool | None)

• data_conversion_params (Dict[str, Any] | None)

• dataset_schema (List[openapi_client.models.column_name_and_type.ColumnNameAndType])

• dist_key (str | None)

• dist_type (str | None)

• dq_constraints (List[Dict[str, Any]] | None)

• global_secondary_indexes (List[Dict[str, Any]] | None)

• identity_attribute_values (List[str] | None)

• is_identity_needed (str | None)

• latest_record_indicator (openapi_client.models.column_name_and_type.ColumnNameAndType | None)

• local_secondary_indexes (List[Dict[str, Any]] | None)

• partition_key (openapi_client.models.column_name_and_type.ColumnNameAndType | None)

• partition_keys (List[Dict[str, Any]] | None)

• precombine_key (str | None)

• primary_key (str | None)

• primary_keys (List[str] | None)

• record_keys (List[str] | None)

• sort_key (openapi_client.models.column_name_and_type.ColumnNameAndType | None)

• sort_keys (List[str] | None)

• sort_type (str | None)

• storage_type (str | None)

• unique_columns (List[str] | None)

field dataset_schema: List[ColumnNameAndType] [Required] (alias 'DatasetSchema')

Column definitions for the dataset table. Required for all targets. Each item must have name and type.

field record_keys: Optional[List[StrictStr]] = None (alias 'RecordKeys')

Column names used as record keys for update-mode datasets. Required when TableUpdate is “update”.

field latest_record_indicator: Optional[ColumnNameAndType] = None (alias 'LatestRecordIndicator')

Column used to determine the latest record version. Required when TableUpdate is “update”.

field partition_keys: Optional[List[Dict[str, Any]]] = None (alias 'PartitionKeys')

Partition key definitions for s3athena/lf targets. Each item has name and type.

field sort_type: Optional[StrictStr] = None (alias 'SortType')

Redshift sort key type.

field dist_type: Optional[StrictStr] = None (alias 'DistType')

Redshift distribution style.

field sort_keys: Optional[List[StrictStr]] = None (alias 'SortKeys')

Redshift sort key column names.

field dist_key: Optional[StrictStr] = None (alias 'DistKey')

Redshift distribution key column name. Required when DistType is KEY.

field primary_keys: Optional[List[StrictStr]] = None (alias 'PrimaryKeys')

Primary key column names for Redshift tables.

field unique_columns: Optional[List[StrictStr]] = None (alias 'UniqueColumns')

Columns with unique constraints for Redshift tables.

field is_identity_needed: Optional[StrictStr] = None (alias 'IsIdentityNeeded')

Whether to add an identity column to the Redshift table (“yes” or “no”).

field identity_attribute_values: Optional[List[StrictStr]] = None (alias 'IdentityAttributeValues')

Identity column seed and step values for Redshift (two string values).

field data_conversion_params: Optional[Dict[str, Any]] = None (alias 'DataConversionParams')

Data conversion parameters for Redshift COPY command.

field partition_key: Optional[ColumnNameAndType] = None (alias 'PartitionKey')

DynamoDB partition key definition (name and type). Required for DynamoDB targets.

field sort_key: Optional[ColumnNameAndType] = None (alias 'SortKey')

DynamoDB sort key definition (name and type). Optional for DynamoDB targets.

field local_secondary_indexes: Optional[List[Dict[str, Any]]] = None (alias 'LocalSecondaryIndexes')

DynamoDB Local Secondary Index definitions.

field global_secondary_indexes: Optional[List[Dict[str, Any]]] = None (alias 'GlobalSecondaryIndexes')

DynamoDB Global Secondary Index definitions.

field storage_type: Optional[StrictStr] = None (alias 'StorageType')

DynamoDB billing mode (PAY_PER_REQUEST or PROVISIONED).

field primary_key: Optional[StrictStr] = None (alias 'PrimaryKey')

Hudi primary key column name. Required for Hudi datasets.

field precombine_key: Optional[StrictStr] = None (alias 'PrecombineKey')

Hudi precombine field for deduplication. Required for Hudi datasets.

field dq_constraints: Optional[List[Dict[str, Any]]] = None (alias 'DqConstraints')

Data quality constraint definitions to create alongside the dataset.

field are_auto_constraint_suggestions_enabled: Optional[StrictBool] = None (alias 'AreAutoConstraintSuggestionsEnabled')

Whether to enable automatic DQ constraint suggestions.

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

Return type:

Optional[Self]