IAM / Client / update_saml_provider

update_saml_provider#

IAM.Client.update_saml_provider(**kwargs)#

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

Note

This operation requires Signature Version 4.

See also: AWS API Documentation

Request Syntax

response = client.update_saml_provider(
    SAMLMetadataDocument='string',
    SAMLProviderArn='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.

  • SAMLProviderArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the SAML provider to update.

    For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

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.

Exceptions