:doc:`Braket <../../braket>` / Client / create_quantum_task

*******************
create_quantum_task
*******************



.. py:method:: Braket.Client.create_quantum_task(**kwargs)

  

  Creates a quantum task.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/CreateQuantumTask>`_  


  **Request Syntax**
  ::

    response = client.create_quantum_task(
        clientToken='string',
        deviceArn='string',
        deviceParameters='string',
        shots=123,
        outputS3Bucket='string',
        outputS3KeyPrefix='string',
        action='string',
        tags={
            'string': 'string'
        },
        jobToken='string',
        associations=[
            {
                'arn': 'string',
                'type': 'RESERVATION_TIME_WINDOW_ARN'
            },
        ],
        experimentalCapabilities={
            'enabled': 'ALL'|'NONE'
        }
    )
    
  :type clientToken: string
  :param clientToken: **[REQUIRED]** 

    The client token associated with the request.

    This field is autopopulated if not provided.

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

    The ARN of the device to run the quantum task on.

    

  
  :type deviceParameters: string
  :param deviceParameters: 

    The parameters for the device to run the quantum task on.

    

  
  :type shots: integer
  :param shots: **[REQUIRED]** 

    The number of shots to use for the quantum task.

    

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

    The S3 bucket to store quantum task result files in.

    

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

    The key prefix for the location in the S3 bucket to store quantum task results in.

    

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

    The action associated with the quantum task.

    

  
  :type tags: dict
  :param tags: 

    Tags to be added to the quantum task you're creating.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type jobToken: string
  :param jobToken: 

    The token for an Amazon Braket hybrid job that associates it with the quantum task.

    

  
  :type associations: list
  :param associations: 

    The list of Amazon Braket resources associated with the quantum task.

    

  
    - *(dict) --* 

      The Amazon Braket resource and the association type.

      

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

        The Amazon Braket resource arn.

        

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

        The association type for the specified Amazon Braket resource arn.

        

      
    

  :type experimentalCapabilities: dict
  :param experimentalCapabilities: 

    Enable experimental capabilities for the quantum task.

    .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``enabled``. 

  
    - **enabled** *(string) --* 

      Enabled experimental capabilities.

      

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

    
    ::

      {
          'quantumTaskArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **quantumTaskArn** *(string) --* 

        The ARN of the quantum task created by the request.

        
  
  **Exceptions**
  
  *   :py:class:`Braket.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Braket.Client.exceptions.DeviceOfflineException`

  
  *   :py:class:`Braket.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Braket.Client.exceptions.DeviceRetiredException`

  
  *   :py:class:`Braket.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`Braket.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Braket.Client.exceptions.ValidationException`

  