Skip to content

update_configured_table

update_configured_table(
    configured_table_identifier: ConfiguredTableIdentifier,
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    name: Optional[DisplayName] = None,
    description: Optional[TableDescription] = None,
    table_reference: Optional[TableReference] = None,
    allowed_columns: Optional[AllowedColumnList] = None,
    analysis_method: Optional[AnalysisMethod] = None,
    selected_analysis_methods: Optional[SelectedAnalysisMethods] = None,
) -> UpdateConfiguredTableOutput

Updates a configured table.

Parameters:

  • configured_table_identifier (ConfiguredTableIdentifier) –

    The identifier for the configured table to update. Currently accepts the configured table ID.

  • name (Optional[DisplayName], default: None ) –

    A new name for the configured table.

  • description (Optional[TableDescription], default: None ) –

    A new description for the configured table.

  • allowed_columns (Optional[AllowedColumnList], default: None ) –

    The columns of the underlying table that can be used by collaborations or analysis rules.

  • analysis_method (Optional[AnalysisMethod], default: None ) –

    The analysis method for the configured table.

    DIRECT_QUERY allows SQL queries to be run directly on this table.

    DIRECT_JOB allows PySpark jobs to be run directly on this table.

    MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

  • selected_analysis_methods (Optional[SelectedAnalysisMethods], default: None ) –

    The selected analysis methods for the table configuration update.

Raises:

Source code in docs_src/capo_cleanrooms/_services/clean_rooms.py
def update_configured_table(
    self,
    configured_table_identifier: "capo_cleanrooms.types.configured_table_identifier.ConfiguredTableIdentifier",
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    name: Optional["capo_cleanrooms.types.display_name.DisplayName"] = None,
    description: Optional[
        "capo_cleanrooms.types.table_description.TableDescription"
    ] = None,
    table_reference: Optional[
        "capo_cleanrooms.types.table_reference.TableReference"
    ] = None,
    allowed_columns: Optional[
        "capo_cleanrooms.types.allowed_column_list.AllowedColumnList"
    ] = None,
    analysis_method: Optional[
        "capo_cleanrooms.types.analysis_method.AnalysisMethod"
    ] = None,
    selected_analysis_methods: Optional[
        "capo_cleanrooms.types.selected_analysis_methods.SelectedAnalysisMethods"
    ] = None,
) -> "capo_cleanrooms.types.update_configured_table_output.UpdateConfiguredTableOutput":
    """<p>Updates a configured table.</p>

    Args:
        configured_table_identifier: <p>The identifier for the configured table to update. Currently accepts the configured table ID.</p>
        name: <p>A new name for the configured table.</p>
        description: <p>A new description for the configured table.</p>
        allowed_columns: <p>The columns of the underlying table that can be used by collaborations or analysis rules.</p>
        analysis_method: <p> The analysis method for the configured table.</p> <p> <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p> <p> <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p> <p> <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>
        selected_analysis_methods: <p> The selected analysis methods for the table configuration update.</p>

    Raises:
        capo_cleanrooms.errors.access_denied_exception.AccessDeniedException: <p>Caller does not have sufficient access to perform this action.</p>
        capo_cleanrooms.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_cleanrooms.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_cleanrooms.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_cleanrooms.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request denied because service quota has been exceeded.</p>
        capo_cleanrooms.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_cleanrooms.errors.validation_exception.ValidationException: <p>The input fails to satisfy the specified constraints.</p>
        capo_cleanrooms.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cleanrooms.types.update_configured_table_input.UpdateConfiguredTableInput]",
    ) -> OperationResponse[
        "capo_cleanrooms.types.update_configured_table_output.UpdateConfiguredTableOutput"
    ]:
        import capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.update_configured_table

        output, http_response = (
            capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.update_configured_table.update_configured_table(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateConfiguredTable")
    )
    input_: capo_cleanrooms.types.update_configured_table_input.UpdateConfiguredTableInput = {
        "configured_table_identifier": configured_table_identifier
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if table_reference is not None:
        input_["table_reference"] = table_reference
    if allowed_columns is not None:
        input_["allowed_columns"] = allowed_columns
    if analysis_method is not None:
        input_["analysis_method"] = analysis_method
    if selected_analysis_methods is not None:
        input_["selected_analysis_methods"] = selected_analysis_methods

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output