:doc:`CloudDirectory <../../clouddirectory>` / Client / disable_directory

*****************
disable_directory
*****************



.. py:method:: CloudDirectory.Client.disable_directory(**kwargs)

  

  Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DisableDirectory>`_  


  **Request Syntax**
  ::

    response = client.disable_directory(
        DirectoryArn='string'
    )
    
  :type DirectoryArn: string
  :param DirectoryArn: **[REQUIRED]** 

    The ARN of the directory to disable.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **DirectoryArn** *(string) --* 

        The ARN of the directory that has been disabled.

        
  
  **Exceptions**
  
  *   :py:class:`CloudDirectory.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.DirectoryDeletedException`

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

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

  
  *   :py:class:`CloudDirectory.Client.exceptions.LimitExceededException`

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

  
  *   :py:class:`CloudDirectory.Client.exceptions.RetryableConflictException`

  
  *   :py:class:`CloudDirectory.Client.exceptions.InvalidArnException`

  