Skip to content

UpdateSecurityConfigRequest

Source code in docs_src/capo_opensearchserverless/types/update_security_config_request.py
class UpdateSecurityConfigRequest(TypedDict, closed=True):
    id: "capo_opensearchserverless.types.security_config_id.SecurityConfigId"
    """<p>The security configuration identifier. For SAML the ID will be <code>saml/&lt;accountId&gt;/&lt;idpProviderName&gt;</code>. For example, <code>saml/123456789123/OKTADev</code>.</p>"""
    config_version: "capo_opensearchserverless.types.policy_version.PolicyVersion"
    """<p>The version of the security configuration to be updated. You can find the most recent version of a security configuration using the <code>GetSecurityPolicy</code> command.</p>"""
    description: NotRequired[
        "capo_opensearchserverless.types.config_description.ConfigDescription"
    ]
    """<p>A description of the security configuration.</p>"""
    saml_options: NotRequired[
        "capo_opensearchserverless.types.saml_config_options.SamlConfigOptions"
    ]
    """<p>SAML options in in the form of a key-value map.</p>"""
    iam_identity_center_options_updates: NotRequired[
        "capo_opensearchserverless.types.update_iam_identity_center_config_options.UpdateIamIdentityCenterConfigOptions"
    ]
    """<p>Describes IAM Identity Center options in the form of a key-value map.</p>"""
    iam_federation_options: NotRequired[
        "capo_opensearchserverless.types.iam_federation_config_options.IamFederationConfigOptions"
    ]
    """<p>Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.</p>"""
    client_token: NotRequired[
        "capo_opensearchserverless.types.client_token.ClientToken"
    ]
    """<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

Unique, case-sensitive identifier to ensure idempotency of the request.

config_version instance-attribute

config_version: PolicyVersion

The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.

description instance-attribute

description: NotRequired[ConfigDescription]

A description of the security configuration.

iam_federation_options instance-attribute

iam_federation_options: NotRequired[IamFederationConfigOptions]

Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.

iam_identity_center_options_updates instance-attribute

iam_identity_center_options_updates: NotRequired[UpdateIamIdentityCenterConfigOptions]

Describes IAM Identity Center options in the form of a key-value map.

id instance-attribute

The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

saml_options instance-attribute

saml_options: NotRequired[SamlConfigOptions]

SAML options in in the form of a key-value map.