QuickSight / Client / search_spaces

search_spaces¶

QuickSight.Client.search_spaces(**kwargs)¶

Searches for Amazon QuickSight spaces that match the specified filters.

Request Syntax

response = client.search_spaces(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'name': 'SPACE_ID'|'SPACE_NAME'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'CONTRIBUTED_BY'|'CONSUMED_SOURCE_SIZE'|'CREATED_BY',
            'operator': 'STRING_EQUALS'|'STRING_LIKE'|'NUMBER_RANGE',
            'value': 'string'
        },
    ]
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the spaces.
NextToken (string) – The token for the next set of results, or null if there are no more results.
MaxResults (integer) – The maximum number of results to return.
Filters (list) –
[REQUIRED]

The filters to apply to the search.
- (dict) –
  
  A filter to use when searching for spaces.
  - name (string) – [REQUIRED]
    
    The name of the filter field to use.
  - operator (string) – [REQUIRED]
    
    The comparison operator to use for the filter.
  - value (string) – [REQUIRED]
    
    The value to use for the filter.

Return type:

dict

Returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'SpaceSummaries': [
        {
            'spaceId': 'string',
            'spaceArn': 'string',
            'name': 'string',
            'description': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'consumedSourceSize': 123,
            'consumedSourceDocCount': 123,
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'createdByArn': 'string',
            'resourcesCount': 123
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

(dict) –
- spaceId (string) –
  
  The ID of the space.
- spaceArn (string) –
  
  The ARN of the space.
- SpaceSummaries (list) –
  
  A list of space summaries that match the search criteria.
  - (dict) –
    
    A summary of an Amazon QuickSight space.
    - spaceId (string) –
      
      The ID of the space.
    - spaceArn (string) –
      
      The ARN of the space.
    - name (string) –
      
      The display name of the space.
    - description (string) –
      
      The description of the space.
    - updatedAt (datetime) –
      
      The date and time that the space was last updated.
    - consumedSourceSize (integer) –
      
      The total consumed source size in bytes.
    - consumedSourceDocCount (integer) –
      
      The number of consumed source documents.
    - createdAt (datetime) –
      
      The date and time that the space was created.
    - createdBy (string) –
      
      The user who created the space.
    - createdByArn (string) –
      
      The ARN of the user who created the space.
    - resourcesCount (integer) –
      
      The number of resources in the space.
- NextToken (string) –
  
  The token for the next set of results, or null if there are no more results.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.AccessDeniedException