:doc:`KMS <../../kms>` / Client / list_key_policies

*****************
list_key_policies
*****************



.. py:method:: KMS.Client.list_key_policies(**kwargs)

  

  Gets the names of the key policies that are attached to a KMS key. This operation is designed to get policy names that you can use in a  GetKeyPolicy operation. However, the only valid policy name is ``default``.

   

  **Cross-account use**: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

   

  **Required permissions**: `kms\:ListKeyPolicies <https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html>`__ (key policy)

   

  **Related operations:**

   

  
  *  GetKeyPolicy
   
  * `PutKeyPolicy <https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html>`__
  

   

  **Eventual consistency**: The KMS API follows an eventual consistency model. For more information, see `KMS eventual consistency <https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPolicies>`_  


  **Request Syntax**
  ::

    response = client.list_key_policies(
        KeyId='string',
        Limit=123,
        Marker='string'
    )
    
  :type KeyId: string
  :param KeyId: **[REQUIRED]** 

    Gets the names of key policies for the specified KMS key.

     

    Specify the key ID or key ARN of the KMS key.

     

    For example:

     

    
    * Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab``
     
    * Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``
    

     

    To get the key ID and key ARN for a KMS key, use  ListKeys or  DescribeKey.

    

  
  :type Limit: integer
  :param Limit: 

    Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

     

    This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

     

    Only one policy can be attached to a key.

    

  
  :type Marker: string
  :param Marker: 

    Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of ``NextMarker`` from the truncated response you just received.

    

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

    
    ::

      {
          'PolicyNames': [
              'string',
          ],
          'NextMarker': 'string',
          'Truncated': True|False
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PolicyNames** *(list) --* 

        A list of key policy names. The only valid value is ``default``.

        
        

        - *(string) --* 
    
      

      - **NextMarker** *(string) --* 

        When ``Truncated`` is true, this element is present and contains the value to use for the ``Marker`` parameter in a subsequent request.

        
      

      - **Truncated** *(boolean) --* 

        A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the ``NextMarker`` element in this response to the ``Marker`` parameter in a subsequent request.

        
  
  **Exceptions**
  
  *   :py:class:`KMS.Client.exceptions.NotFoundException`

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

  
  *   :py:class:`KMS.Client.exceptions.DependencyTimeoutException`

  
  *   :py:class:`KMS.Client.exceptions.KMSInternalException`

  
  *   :py:class:`KMS.Client.exceptions.KMSInvalidStateException`

  

  **Examples**

  The following example lists key policies for the specified KMS key.
  ::

    response = client.list_key_policies(
        # The identifier of the KMS key whose key policies you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
        KeyId='1234abcd-12ab-34cd-56ef-1234567890ab',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        # A list of key policy names.
        'PolicyNames': [
            'default',
        ],
        # A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
        'Truncated': False,
        'ResponseMetadata': {
            '...': '...',
        },
    }

  