:doc:`Connect <../../connect>` / Paginator / SearchWorkspaceAssociations

***************************
SearchWorkspaceAssociations
***************************



.. py:class:: Connect.Paginator.SearchWorkspaceAssociations

  ::

    
    paginator = client.get_paginator('search_workspace_associations')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Connect.Client.search_workspace_associations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchWorkspaceAssociations>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          InstanceId='string',
          SearchFilter={
              'AttributeFilter': {
                  'OrConditions': [
                      {
                          'TagConditions': [
                              {
                                  'TagKey': 'string',
                                  'TagValue': 'string'
                              },
                          ]
                      },
                  ],
                  'AndCondition': {
                      'TagConditions': [
                          {
                              'TagKey': 'string',
                              'TagValue': 'string'
                          },
                      ]
                  },
                  'TagCondition': {
                      'TagKey': 'string',
                      'TagValue': 'string'
                  }
              }
          },
          SearchCriteria={
              'OrConditions': [
                  {'... recursive ...'},
              ],
              'AndConditions': [
                  {'... recursive ...'},
              ],
              'StringCondition': {
                  'FieldName': 'string',
                  'Value': 'string',
                  'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
              }
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type InstanceId: string
    :param InstanceId: **[REQUIRED]** 

      The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

      

    
    :type SearchFilter: dict
    :param SearchFilter: 

      Filters to apply to the search, such as tag-based filters.

      

    
      - **AttributeFilter** *(dict) --* 

        An object that can be used to specify Tag conditions inside the ``SearchFilter``. This accepts an ``OR`` or ``AND`` (List of List) input where:

         

        
        * The top level list specifies conditions that need to be applied with ``OR`` operator.
         
        * The inner list specifies conditions that need to be applied with ``AND`` operator.
        

        

      
        - **OrConditions** *(list) --* 

          A list of conditions which would be applied together with an ``OR`` condition.

          

        
          - *(dict) --* 

            A list of conditions which would be applied together with an ``AND`` condition.

            

          
            - **TagConditions** *(list) --* 

              A leaf node condition which can be used to specify a tag condition.

              

            
              - *(dict) --* 

                A leaf node condition which can be used to specify a tag condition, for example, ``HAVE BPO = 123``.

                

              
                - **TagKey** *(string) --* 

                  The tag key in the tag condition.

                  

                
                - **TagValue** *(string) --* 

                  The tag value in the tag condition.

                  

                
              
          
          
      
        - **AndCondition** *(dict) --* 

          A list of conditions which would be applied together with an ``AND`` condition.

          

        
          - **TagConditions** *(list) --* 

            A leaf node condition which can be used to specify a tag condition.

            

          
            - *(dict) --* 

              A leaf node condition which can be used to specify a tag condition, for example, ``HAVE BPO = 123``.

              

            
              - **TagKey** *(string) --* 

                The tag key in the tag condition.

                

              
              - **TagValue** *(string) --* 

                The tag value in the tag condition.

                

              
            
        
        
        - **TagCondition** *(dict) --* 

          A leaf node condition which can be used to specify a tag condition, for example, ``HAVE BPO = 123``.

          

        
          - **TagKey** *(string) --* 

            The tag key in the tag condition.

            

          
          - **TagValue** *(string) --* 

            The tag value in the tag condition.

            

          
        
      
    
    :type SearchCriteria: dict
    :param SearchCriteria: 

      The search criteria, including workspace ID, resource ID, or resource type.

      

    
      - **OrConditions** *(list) --* 

        A list of conditions to be met, where at least one condition must be satisfied.

        

      
        - *(dict) --* 

          Defines the search criteria for filtering workspace associations.

          

        
    
      - **AndConditions** *(list) --* 

        A list of conditions that must all be satisfied.

        

      
        - *(dict) --* 

          Defines the search criteria for filtering workspace associations.

          

        
    
      - **StringCondition** *(dict) --* 

        A leaf node condition which can be used to specify a string condition.

        

      
        - **FieldName** *(string) --* 

          The name of the field in the string condition.

          

        
        - **Value** *(string) --* 

          The value of the string.

          

        
        - **ComparisonType** *(string) --* 

          The type of comparison to be made when evaluating the string condition.

          

        
      
    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'WorkspaceAssociations': [
                {
                    'WorkspaceId': 'string',
                    'WorkspaceArn': 'string',
                    'ResourceId': 'string',
                    'ResourceArn': 'string',
                    'ResourceType': 'string',
                    'ResourceName': 'string'
                },
            ],
            'ApproximateTotalCount': 123
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **WorkspaceAssociations** *(list) --* 

          A list of workspace associations that match the search criteria.

          
          

          - *(dict) --* 

            Contains summary information about a workspace association with a user or routing profile.

            
            

            - **WorkspaceId** *(string) --* 

              The identifier of the workspace.

              
            

            - **WorkspaceArn** *(string) --* 

              The Amazon Resource Name (ARN) of the workspace.

              
            

            - **ResourceId** *(string) --* 

              The identifier of the associated resource (user or routing profile).

              
            

            - **ResourceArn** *(string) --* 

              The Amazon Resource Name (ARN) of the associated resource.

              
            

            - **ResourceType** *(string) --* 

              The type of resource associated with the workspace. Valid values are: ``USER`` and ``ROUTING_PROFILE``.

              
            

            - **ResourceName** *(string) --* 

              The name of the associated resource.

              
        
      
        

        - **ApproximateTotalCount** *(integer) --* 

          The approximate total number of workspace associations that match the search criteria.

          
    