Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateConfiguredTable

Updates a configured table.

Request Syntax


PATCH /configuredTables/configuredTableIdentifier HTTP/1.1
Content-type: application/json

{
   "allowedColumns": [ "string" ],
   "analysisMethod": "string",
   "description": "string",
   "name": "string",
   "selectedAnalysisMethods": [ "string" ],
   "tableReference": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

configuredTableIdentifier

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

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

allowedColumns

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

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-z0-9_](([a-z0-9_ ]+-)*([a-z0-9_ ]+))?

Required: No

analysisMethod

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.

Type: String

Valid Values: DIRECT_QUERY | DIRECT_JOB | MULTIPLE

Required: No

description

A new description for the configured table.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

Required: No

name

A new name for the configured table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*

Required: No

selectedAnalysisMethods

The selected analysis methods for the table configuration update.

Type: Array of strings

Valid Values: DIRECT_QUERY | DIRECT_JOB

Required: No

tableReference

A pointer to the dataset that underlies this table.

Type: TableReference object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "configuredTable": { 
      "allowedColumns": [ "string" ],
      "analysisMethod": "string",
      "analysisRuleTypes": [ "string" ],
      "arn": "string",
      "createTime": number,
      "description": "string",
      "id": "string",
      "name": "string",
      "selectedAnalysisMethods": [ "string" ],
      "tableReference": { ... },
      "updateTime": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

configuredTable

The updated configured table.

Type: ConfiguredTable object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Caller does not have sufficient access to perform this action.

reason: A reason code for the exception.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

reason: A reason code for the exception.
resourceId: The ID of the conflicting resource.
resourceType: The type of the conflicting resource.

HTTP Status Code: 409

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

resourceId: The Id of the missing resource.
resourceType: The type of the missing resource.

HTTP Status Code: 404

ServiceQuotaExceededException

Request denied because service quota has been exceeded.

quotaName: The name of the quota.
quotaValue: The value of the quota.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

fieldList: Validation errors for specific input parameters.
reason: A reason code for the exception.

HTTP Status Code: 400