:doc:`SamlProvider <index>` / Action / update

******
update
******



.. py:method:: IAM.SamlProvider.update(**kwargs)

  

  Updates the metadata document, SAML encryption settings, and private keys for an existing SAML provider. To rotate private keys, add your new private key and then remove the old key in a separate request.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/UpdateSAMLProvider>`_  


  **Request Syntax**
  ::

    response = saml_provider.update(
        SAMLMetadataDocument='string',
        AssertionEncryptionMode='Required'|'Allowed',
        AddPrivateKey='string',
        RemovePrivateKey='string'
    )
    
  :type SAMLMetadataDocument: string
  :param SAMLMetadataDocument: 

    An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your IdP.

    

  
  :type AssertionEncryptionMode: string
  :param AssertionEncryptionMode: 

    Specifies the encryption setting for the SAML provider.

    

  
  :type AddPrivateKey: string
  :param AddPrivateKey: 

    Specifies the new private key from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

    

  
  :type RemovePrivateKey: string
  :param RemovePrivateKey: 

    The Key ID of the private key to remove.

    

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

    
    ::

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

    

    - *(dict) --* 

      Contains the response to a successful `UpdateSAMLProvider <https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateSAMLProvider.html>`__ request.

      
      

      - **SAMLProviderArn** *(string) --* 

        The Amazon Resource Name (ARN) of the SAML provider that was updated.

        
  