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

UpdateProtectedQuery

Updates the processing of a currently running query.

Request Syntax


PATCH /memberships/membershipIdentifier/protectedQueries/protectedQueryIdentifier HTTP/1.1
Content-type: application/json

{
   "targetStatus": "string"
}

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

The identifier for a member of a protected query instance.

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

protectedQueryIdentifier

The identifier for a protected query instance.

Length Constraints: Minimum length of 1. Maximum 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.

targetStatus

The target status of a query. Used to update the execution status of a currently running query.

Type: String

Valid Values: CANCELLED

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "protectedQuery": { 
      "createTime": number,
      "error": { 
         "code": "string",
         "message": "string"
      },
      "id": "string",
      "membershipArn": "string",
      "membershipId": "string",
      "result": { 
         "output": { 
            "s3": { 
               "location": "string"
            }
         }
      },
      "resultConfiguration": { 
         "outputConfiguration": { 
            "s3": { 
               "bucket": "string",
               "keyPrefix": "string",
               "resultFormat": "string"
            }
         }
      },
      "sqlParameters": { 
         "queryString": "string"
      },
      "statistics": { 
         "totalDurationInMillis": number
      },
      "status": "string"
   }
}

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.

protectedQuery

The protected query output.

Type: ProtectedQuery 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.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

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.

HTTP Status Code: 400