CleanRoomsService / Client / get_protected_query
get_protected_query#
- CleanRoomsService.Client.get_protected_query(**kwargs)#
Returns query processing metadata.
See also: AWS API Documentation
Request Syntax
response = client.get_protected_query( membershipIdentifier='string', protectedQueryIdentifier='string' )
- Parameters:
membershipIdentifier (string) –
[REQUIRED]
The identifier for a membership in a protected query instance.
protectedQueryIdentifier (string) –
[REQUIRED]
The identifier for a protected query instance.
- Return type:
dict
- Returns:
Response Syntax
{ 'protectedQuery': { 'id': 'string', 'membershipId': 'string', 'membershipArn': 'string', 'createTime': datetime(2015, 1, 1), 'sqlParameters': { 'queryString': 'string', 'analysisTemplateArn': 'string', 'parameters': { 'string': 'string' } }, 'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'TIMED_OUT', 'resultConfiguration': { 'outputConfiguration': { 's3': { 'resultFormat': 'CSV'|'PARQUET', 'bucket': 'string', 'keyPrefix': 'string' } } }, 'statistics': { 'totalDurationInMillis': 123 }, 'result': { 'output': { 's3': { 'location': 'string' } } }, 'error': { 'message': 'string', 'code': 'string' } } }
Response Structure
(dict) –
protectedQuery (dict) –
The query processing metadata.
id (string) –
The identifier for a protected query instance.
membershipId (string) –
The identifier for the membership.
membershipArn (string) –
The ARN of the membership.
createTime (datetime) –
The time at which the protected query was created.
sqlParameters (dict) –
The protected query SQL parameters.
queryString (string) –
The query string to be submitted.
analysisTemplateArn (string) –
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
parameters (dict) –
The protected query SQL parameters.
(string) –
(string) –
status (string) –
The status of the query.
resultConfiguration (dict) –
Contains any details needed to write the query results.
outputConfiguration (dict) –
Configuration for protected query results.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
s3
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
s3 (dict) –
Required configuration for a protected query with an S3 output type.
resultFormat (string) –
Intended file format of the result.
bucket (string) –
The S3 bucket to unload the protected query results.
keyPrefix (string) –
The S3 prefix to unload the protected query results.
statistics (dict) –
Statistics about protected query execution.
totalDurationInMillis (integer) –
The duration of the Protected Query, from creation until query completion.
result (dict) –
The result of the protected query.
output (dict) –
The output of the protected query.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
s3
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
s3 (dict) –
If present, the output for a protected query with an S3 output type.
location (string) –
The S3 location of the result.
error (dict) –
An error thrown by the protected query.
message (string) –
A description of why the query failed.
code (string) –
An error code for the error.
Exceptions
CleanRoomsService.Client.exceptions.ResourceNotFoundException
CleanRoomsService.Client.exceptions.InternalServerException
CleanRoomsService.Client.exceptions.ValidationException
CleanRoomsService.Client.exceptions.ThrottlingException
CleanRoomsService.Client.exceptions.AccessDeniedException