CleanRoomsService / Client / list_protected_queries

list_protected_queries#

CleanRoomsService.Client.list_protected_queries(**kwargs)#

Lists protected queries, sorted by the most recent query.

Request Syntax

response = client.list_protected_queries(
    membershipIdentifier='string',
    status='SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'TIMED_OUT',
    nextToken='string',
    maxResults=123
)

Parameters:

membershipIdentifier (string) –
[REQUIRED]

The identifier for the membership in the collaboration.
status (string) – A filter on the status of the protected query.
nextToken (string) – The pagination token that’s used to fetch the next set of results.
maxResults (integer) – The maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a nextToken even if the maxResults value has not been met.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'protectedQueries': [
        {
            'id': 'string',
            'membershipId': 'string',
            'membershipArn': 'string',
            'createTime': datetime(2015, 1, 1),
            'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'TIMED_OUT',
            'receiverConfigurations': [
                {
                    'analysisType': 'DIRECT_ANALYSIS'|'ADDITIONAL_ANALYSIS',
                    'configurationDetails': {
                        'directAnalysisConfigurationDetails': {
                            'receiverAccountIds': [
                                'string',
                            ]
                        }
                    }
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The pagination token that’s used to fetch the next set of results.
- protectedQueries (list) –
  
  A list of protected queries.
  - (dict) –
    
    The protected query summary for the objects listed by the request.
    - id (string) –
      
      The unique ID of the protected query.
    - membershipId (string) –
      
      The unique ID for the membership that initiated the protected query.
    - membershipArn (string) –
      
      The unique ARN for the membership that initiated the protected query.
    - createTime (datetime) –
      
      The time the protected query was created.
    - status (string) –
      
      The status of the protected query.
    - receiverConfigurations (list) –
      
      The receiver configuration.
      - (dict) –
        
        The receiver configuration for a protected query.
        
        analysisType (string) –
        
        The type of analysis for the protected query. The results of the query can be analyzed directly ( DIRECT_ANALYSIS) or used as input into additional analyses ( ADDITIONAL_ANALYSIS), such as a query that is a seed for a lookalike ML model.
        
        configurationDetails (dict) –
        
        The configuration details of the receiver configuration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: directAnalysisConfigurationDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        directAnalysisConfigurationDetails (dict) –
        
        The direct analysis configuration details.
        
        receiverAccountIds (list) –
        
        The account IDs for the member who received the results of a protected query.
        
        (string) –

Exceptions

CleanRoomsService.Client.exceptions.ResourceNotFoundException
CleanRoomsService.Client.exceptions.InternalServerException
CleanRoomsService.Client.exceptions.ValidationException
CleanRoomsService.Client.exceptions.ThrottlingException
CleanRoomsService.Client.exceptions.AccessDeniedException