:doc:`WorkSpaces <../../workspaces>` / Paginator / DescribeWorkspaceBundles

************************
DescribeWorkspaceBundles
************************



.. py:class:: WorkSpaces.Paginator.DescribeWorkspaceBundles

  ::

    
    paginator = client.get_paginator('describe_workspace_bundles')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`WorkSpaces.Client.describe_workspace_bundles`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundles>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          BundleIds=[
              'string',
          ],
          Owner='string',
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type BundleIds: list
    :param BundleIds: 

      The identifiers of the bundles. You cannot combine this parameter with any other filter.

      

    
      - *(string) --* 

      
  
    :type Owner: string
    :param Owner: 

      The owner of the bundles. You cannot combine this parameter with any other filter.

       

      To describe the bundles provided by Amazon Web Services, specify ``AMAZON``. To describe the bundles that belong to your account, don't specify a value.

      

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

        

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

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

        

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

      
      ::

        {
            'Bundles': [
                {
                    'BundleId': 'string',
                    'Name': 'string',
                    'Owner': 'string',
                    'Description': 'string',
                    'ImageId': 'string',
                    'RootStorage': {
                        'Capacity': 'string'
                    },
                    'UserStorage': {
                        'Capacity': 'string'
                    },
                    'ComputeType': {
                        'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GENERALPURPOSE_4XLARGE'|'GENERALPURPOSE_8XLARGE'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'|'GRAPHICS_G6_XLARGE'|'GRAPHICS_G6_2XLARGE'|'GRAPHICS_G6_4XLARGE'|'GRAPHICS_G6_8XLARGE'|'GRAPHICS_G6_16XLARGE'|'GRAPHICS_GR6_4XLARGE'|'GRAPHICS_GR6_8XLARGE'|'GRAPHICS_G6F_LARGE'|'GRAPHICS_G6F_XLARGE'|'GRAPHICS_G6F_2XLARGE'|'GRAPHICS_G6F_4XLARGE'|'GRAPHICS_GR6F_4XLARGE'
                    },
                    'LastUpdatedTime': datetime(2015, 1, 1),
                    'CreationTime': datetime(2015, 1, 1),
                    'State': 'AVAILABLE'|'PENDING'|'ERROR',
                    'BundleType': 'REGULAR'|'STANDBY'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Bundles** *(list) --* 

          Information about the bundles.

          
          

          - *(dict) --* 

            Describes a WorkSpace bundle.

            
            

            - **BundleId** *(string) --* 

              The identifier of the bundle.

              
            

            - **Name** *(string) --* 

              The name of the bundle.

              
            

            - **Owner** *(string) --* 

              The owner of the bundle. This is the account identifier of the owner, or ``AMAZON`` if the bundle is provided by Amazon Web Services.

              
            

            - **Description** *(string) --* 

              The description of the bundle.

              
            

            - **ImageId** *(string) --* 

              The identifier of the image that was used to create the bundle.

              
            

            - **RootStorage** *(dict) --* 

              The size of the root volume.

              
              

              - **Capacity** *(string) --* 

                The size of the root volume.

                
          
            

            - **UserStorage** *(dict) --* 

              The size of the user volume.

              
              

              - **Capacity** *(string) --* 

                The size of the user volume.

                
          
            

            - **ComputeType** *(dict) --* 

              The compute type of the bundle. For more information, see `Amazon WorkSpaces Bundles <http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles>`__.

              
              

              - **Name** *(string) --* 

                The compute type.

                
          
            

            - **LastUpdatedTime** *(datetime) --* 

              The last time that the bundle was updated.

              
            

            - **CreationTime** *(datetime) --* 

              The time when the bundle was created.

              
            

            - **State** *(string) --* 

              The state of the WorkSpace bundle.

              
            

            - **BundleType** *(string) --* 

              The type of WorkSpace bundle.

              
        
      
    