SamlProvider / Action / update

update#

IAM.SamlProvider.update(**kwargs)#

Updates the metadata document for an existing SAML provider resource object.

Note

This operation requires Signature Version 4.

Request Syntax

response = saml_provider.update(
    SAMLMetadataDocument='string',

)

Parameters:

SAMLMetadataDocument (string) –

[REQUIRED]

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 organization’s IdP.

Return type:

dict

Returns:

Response Syntax

{
    'SAMLProviderArn': 'string'
}

Response Structure

(dict) –

Contains the response to a successful UpdateSAMLProvider request.
- SAMLProviderArn (string) –
  
  The Amazon Resource Name (ARN) of the SAML provider that was updated.