:doc:`WorkSpaces <../../workspaces>` / Client / create_workspace_bundle

***********************
create_workspace_bundle
***********************



.. py:method:: WorkSpaces.Client.create_workspace_bundle(**kwargs)

  

  Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see `Create a Custom WorkSpaces Image and Bundle <https://docs.aws.amazon.com/workspaces/latest/adminguide/create-custom-bundle.html>`__.

  

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


  **Request Syntax**
  ::

    response = client.create_workspace_bundle(
        BundleName='string',
        BundleDescription='string',
        ImageId='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'
        },
        UserStorage={
            'Capacity': 'string'
        },
        RootStorage={
            'Capacity': 'string'
        },
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    )
    
  :type BundleName: string
  :param BundleName: **[REQUIRED]** 

    The name of the bundle.

    

  
  :type BundleDescription: string
  :param BundleDescription: **[REQUIRED]** 

    The description of the bundle.

    

  
  :type ImageId: string
  :param ImageId: **[REQUIRED]** 

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

    

  
  :type ComputeType: dict
  :param ComputeType: **[REQUIRED]** 

    Describes the compute type of the bundle.

    

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

      The compute type.

      

    
  
  :type UserStorage: dict
  :param UserStorage: **[REQUIRED]** 

    Describes the user volume for a WorkSpace bundle.

    

  
    - **Capacity** *(string) --* **[REQUIRED]** 

      The size of the user volume.

      

    
  
  :type RootStorage: dict
  :param RootStorage: 

    Describes the root volume for a WorkSpace bundle.

    

  
    - **Capacity** *(string) --* **[REQUIRED]** 

      The size of the root volume.

      

    
  
  :type Tags: list
  :param Tags: 

    The tags associated with the bundle.

     

    .. note::

      

      To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use ``workspaces:CreateTags``.

      

    

  
    - *(dict) --* 

      Describes a tag.

      

    
      - **Key** *(string) --* **[REQUIRED]** 

        The key of the tag.

        

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

        The value of the tag.

        

      
    

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

    
    ::

      {
          'WorkspaceBundle': {
              '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) --* 
      

      - **WorkspaceBundle** *(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.

          
    
  
  **Exceptions**
  
  *   :py:class:`WorkSpaces.Client.exceptions.ResourceUnavailableException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.ResourceAlreadyExistsException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.ResourceLimitExceededException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.InvalidParameterValuesException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.AccessDeniedException`

  