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

UpdateIntermediateTable

Updates an intermediate table. You can update the description, KMS key ARN, and column types of existing columns. Only the intermediate table owner can call this operation.

Request Syntax


PATCH /memberships/membershipIdentifier/intermediateTables/intermediateTableIdentifier HTTP/1.1
Content-type: application/json

{
   "columns": [ 
      { 
         "name": "string",
         "type": "string"
      }
   ],
   "description": "string",
   "kmsKeyArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

intermediateTableIdentifier

The unique identifier of the intermediate table to update.

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

membershipIdentifier

The unique identifier of the membership that contains the intermediate table.

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.

columns

The list of columns with updated type definitions. Only the type of existing columns can be updated.

Type: Array of IntermediateTableColumn objects

Required: No

description

A new description for the intermediate 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

kmsKeyArn

The Amazon Resource Name (ARN) of the customer-managed KMS key to use for encrypting future population data.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws:kms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:key/[a-zA-Z0-9-]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "intermediateTable": { 
      "analysisRuleTypes": [ "string" ],
      "arn": "string",
      "childResources": [ 
         { 
            "ownerAccountId": "string",
            "resourceId": "string",
            "resourceName": "string",
            "resourceStatus": "string",
            "resourceType": "string"
         }
      ],
      "collaborationArn": "string",
      "collaborationId": "string",
      "createTime": number,
      "description": "string",
      "id": "string",
      "intermediateTableVersion": { 
         "analysisId": "string",
         "analysisType": "string",
         "expirationTime": number,
         "inheritedConstraints": { 
            "additionalAnalyses": { 
               "sources": [ 
                  { 
                     "id": "string",
                     "name": "string",
                     "sourceAccountId": "string",
                     "type": "string",
                     "value": "string"
                  }
               ],
               "value": "string"
            },
            "allowedAdditionalAnalyses": { 
               "sources": [ 
                  { 
                     "id": "string",
                     "name": "string",
                     "sourceAccountId": "string",
                     "type": "string",
                     "value": [ "string" ]
                  }
               ],
               "value": [ "string" ]
            },
            "allowedResultReceivers": { 
               "sources": [ 
                  { 
                     "id": "string",
                     "name": "string",
                     "sourceAccountId": "string",
                     "type": "string",
                     "value": [ "string" ]
                  }
               ],
               "value": [ "string" ]
            },
            "disallowedOutputColumns": { 
               "columnLineage": [ 
                  { 
                     "column": "string",
                     "sourceAccountId": "string",
                     "sourceColumn": "string",
                     "sourceId": "string",
                     "sourceName": "string",
                     "sourceType": "string"
                  }
               ],
               "value": [ "string" ]
            }
         },
         "kmsKeyArn": "string",
         "parameters": { 
            "string" : "string" 
         },
         "versionId": "string"
      },
      "kmsKeyArn": "string",
      "membershipArn": "string",
      "membershipId": "string",
      "name": "string",
      "populationAnalysisConfiguration": { ... },
      "retentionInDays": number,
      "schema": { 
         "columns": [ 
            { 
               "name": "string",
               "type": "string"
            }
         ]
      },
      "status": "string",
      "statusReason": "string",
      "tableDependencies": [ 
         { 
            "creatorAccountId": "string",
            "id": "string",
            "name": "string",
            "parentType": "string",
            "type": "string"
         }
      ],
      "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.

intermediateTable

The updated intermediate table.

Type: IntermediateTable object

Errors

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

AccessDeniedException

Caller does not have sufficient access to perform this action.

reason: A reason code for the exception.

HTTP Status Code: 403

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

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