:doc:`SWF <../../swf>` / Client / register_domain

***************
register_domain
***************



.. py:method:: SWF.Client.register_domain(**kwargs)

  

  Registers a new domain.

   

  **Access Control**

   

  You can use IAM policies to control this action's access to Amazon SWF resources as follows:

   

  
  * You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
   
  * Use an ``Action`` element to allow or deny permission to call this action.
   
  * You cannot use an IAM policy to constrain this action's parameters.
  

   

  If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's ``cause`` parameter is set to ``OPERATION_NOT_PERMITTED``. For details and example IAM policies, see `Using IAM to Manage Access to Amazon SWF Workflows <https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html>`__ in the *Amazon SWF Developer Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/swf-2012-01-25/RegisterDomain>`_  


  **Request Syntax**
  ::

    response = client.register_domain(
        name='string',
        description='string',
        workflowExecutionRetentionPeriodInDays='string',
        tags=[
            {
                'key': 'string',
                'value': 'string'
            },
        ]
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    Name of the domain to register. The name must be unique in the region that the domain is registered in.

     

    The specified string must not start or end with whitespace. It must not contain a ``:`` (colon), ``/`` (slash), ``|`` (vertical bar), or any control characters ( ``\u0000-\u001f`` | ``\u007f-\u009f``). Also, it must *not* be the literal string ``arn``.

    

  
  :type description: string
  :param description: 

    A text description of the domain.

    

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

    The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls.

     

    If you pass the value ``NONE`` or ``0`` (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted.

     

    The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: `Amazon SWF Service Limits <https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-limits.html>`__ in the *Amazon SWF Developer Guide*.

    

  
  :type tags: list
  :param tags: 

    Tags to be added when registering a domain.

     

    Tags may only contain unicode letters, digits, whitespace, or these symbols: ``_ . : / = + - @``.

    

  
    - *(dict) --* 

      Tags are key-value pairs that can be associated with Amazon SWF state machines and activities.

       

      Tags may only contain unicode letters, digits, whitespace, or these symbols: ``_ . : / = + - @``.

      

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

        The key of a tag.

        

      
      - **value** *(string) --* 

        The value of a tag.

        

      
    

  
  :returns: None
  **Exceptions**
  
  *   :py:class:`SWF.Client.exceptions.DomainAlreadyExistsFault`

  
  *   :py:class:`SWF.Client.exceptions.LimitExceededFault`

  
  *   :py:class:`SWF.Client.exceptions.OperationNotPermittedFault`

  
  *   :py:class:`SWF.Client.exceptions.TooManyTagsFault`

  