:doc:`Athena <../../athena>` / Client / create_named_query

******************
create_named_query
******************



.. py:method:: Athena.Client.create_named_query(**kwargs)

  

  Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/CreateNamedQuery>`_  


  **Request Syntax**
  ::

    response = client.create_named_query(
        Name='string',
        Description='string',
        Database='string',
        QueryString='string',
        ClientRequestToken='string',
        WorkGroup='string'
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

    The query name.

    

  
  :type Description: string
  :param Description: 

    The query description.

    

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

    The database to which the query belongs.

    

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

    The contents of the query with all query statements.

    

  
  :type ClientRequestToken: string
  :param ClientRequestToken: 

    A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another ``CreateNamedQuery`` request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the ``QueryString``, an error is returned.

     

    .. warning::

       

      This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

      

    This field is autopopulated if not provided.

  
  :type WorkGroup: string
  :param WorkGroup: 

    The name of the workgroup in which the named query is being created.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **NamedQueryId** *(string) --* 

        The unique ID of the query.

        
  
  **Exceptions**
  
  *   :py:class:`Athena.Client.exceptions.InternalServerException`

  
  *   :py:class:`Athena.Client.exceptions.InvalidRequestException`

  