:doc:`RAM <../../ram>` / Client / delete_permission_version

*************************
delete_permission_version
*************************



.. py:method:: RAM.Client.delete_permission_version(**kwargs)

  

  Deletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version for the permission.

   

  If a customer managed permission has the maximum of 5 versions, then you must delete at least one version before you can create another.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DeletePermissionVersion>`_  


  **Request Syntax**
  ::

    response = client.delete_permission_version(
        permissionArn='string',
        permissionVersion=123,
        clientToken='string'
    )
    
  :type permissionArn: string
  :param permissionArn: **[REQUIRED]** 

    Specifies the `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the permission with the version you want to delete.

    

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

    Specifies the version number to delete.

     

    You can't delete the default version for a customer managed permission.

     

    You can't delete a version if it's the only version of the permission. You must either first create another version, or delete the permission completely.

     

    You can't delete a version if it is attached to any resource shares. If the version is the default, you must first use  SetDefaultPermissionVersion to set a different version as the default for the customer managed permission, and then use  AssociateResourceSharePermission to update your resource shares to use the new default version.

    

  
  :type clientToken: string
  :param clientToken: 

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a `UUID type of value. <https://wikipedia.org/wiki/Universally_unique_identifier>`__.

     

    If you don't provide this value, then Amazon Web Services generates a random one for you.

     

    If you retry the operation with the same ``ClientToken``, but with different parameters, the retry fails with an ``IdempotentParameterMismatch`` error.

    

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

    
    ::

      {
          'returnValue': True|False,
          'clientToken': 'string',
          'permissionStatus': 'ATTACHABLE'|'UNATTACHABLE'|'DELETING'|'DELETED'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **returnValue** *(boolean) --* 

        A boolean value that indicates whether the operation is successful.

        
      

      - **clientToken** *(string) --* 

        The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the ``clientToken`` request parameter of that later call. All other parameters must also have the same values that you used in the first call.

        
      

      - **permissionStatus** *(string) --* 

        This operation is performed asynchronously, and this response parameter indicates the current status.

        
  
  **Exceptions**
  
  *   :py:class:`RAM.Client.exceptions.MalformedArnException`

  
  *   :py:class:`RAM.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`RAM.Client.exceptions.ServerInternalException`

  
  *   :py:class:`RAM.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`RAM.Client.exceptions.OperationNotPermittedException`

  
  *   :py:class:`RAM.Client.exceptions.UnknownResourceException`

  
  *   :py:class:`RAM.Client.exceptions.InvalidClientTokenException`

  
  *   :py:class:`RAM.Client.exceptions.IdempotentParameterMismatchException`

  