Skip to content

UpdateSAMLProviderRequest

Source code in docs_src/capo_iam/types/update_saml_provider_request.py
class UpdateSAMLProviderRequest(TypedDict, closed=True):
    saml_metadata_document: NotRequired[
        "capo_iam.types.saml_metadata_document_type.SAMLMetadataDocumentType"
    ]
    """<p>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.</p>"""
    saml_provider_arn: "capo_iam.types.arn_type.arnType"
    """<p>The Amazon Resource Name (ARN) of the SAML provider to update.</p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>"""
    assertion_encryption_mode: NotRequired[
        "capo_iam.types.assertion_encryption_mode_type.assertionEncryptionModeType"
    ]
    """<p>Specifies the encryption setting for the SAML provider.</p>"""
    add_private_key: NotRequired["capo_iam.types.private_key_type.privateKeyType"]
    """<p>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.</p>"""
    remove_private_key: NotRequired[
        "capo_iam.types.private_key_id_type.privateKeyIdType"
    ]
    """<p>The Key ID of the private key to remove.</p>"""

add_private_key instance-attribute

add_private_key: NotRequired[privateKeyType]

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 instance-attribute

assertion_encryption_mode: NotRequired[assertionEncryptionModeType]

Specifies the encryption setting for the SAML provider.

remove_private_key instance-attribute

remove_private_key: NotRequired[privateKeyIdType]

The Key ID of the private key to remove.

saml_metadata_document instance-attribute

saml_metadata_document: NotRequired[SAMLMetadataDocumentType]

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 instance-attribute

saml_provider_arn: arnType

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.