Skip to content

IAM  >  Operations  >  update_saml_provider

update_saml_provider

Operation

update_saml_provider async 

update_saml_provider(input: UpdateSAMLProviderInput, plugins: list[Plugin] | None = None) -> UpdateSAMLProviderOutput

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.

Parameters:

Name Type Description Default
input UpdateSAMLProviderInput

An instance of UpdateSAMLProviderInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
UpdateSAMLProviderOutput

An instance of UpdateSAMLProviderOutput.

Input

UpdateSAMLProviderInput dataclass

Bases: _SerdeShape

Dataclass for UpdateSAMLProviderInput structure.

Attributes

add_private_key class-attribute instance-attribute 
add_private_key: str | None = ...

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.

assertion_encryption_mode class-attribute instance-attribute 
assertion_encryption_mode: str | None = ...

Specifies the encryption setting for the SAML provider.

remove_private_key class-attribute instance-attribute 
remove_private_key: str | None = ...

The Key ID of the private key to remove.

saml_metadata_document class-attribute instance-attribute 
saml_metadata_document: str | None = ...

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.

saml_provider_arn class-attribute instance-attribute 
saml_provider_arn: str | None = ...

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.

Output

UpdateSAMLProviderOutput dataclass

Bases: _SerdeShape

Contains the response to a successful UpdateSAMLProvider request.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

saml_provider_arn class-attribute instance-attribute 
saml_provider_arn: str | None = ...

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