Skip to content

UpdateInstanceRequest

Source code in docs_src/capo_sso_admin/types/update_instance_request.py
class UpdateInstanceRequest(TypedDict, closed=True):
    name: NotRequired["capo_sso_admin.types.name_type.NameType"]
    """<p>Updates the instance name.</p>"""
    instance_arn: "capo_sso_admin.types.instance_arn.InstanceArn"
    """<p>The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"""
    encryption_configuration: NotRequired[
        "capo_sso_admin.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>Specifies the encryption configuration for your IAM Identity Center instance. You can use this to configure customer managed KMS keys or Amazon Web Services owned KMS keys for encrypting your instance data.</p>"""
    permission_sets_enabled: NotRequired["bool"]
    """<p>Enables permission sets for this Identity Center instance. The only accepted value is <code>true </code>. After permission sets are enabled, they cannot be disabled.</p> <note> <p>You can't set <code>EncryptionConfiguration</code> and <code>PermissionSetsEnabled</code> in the same request. To configure both, make two separate <code>UpdateInstance</code> calls. These calls can be made in parallel.</p> </note>"""

encryption_configuration instance-attribute

encryption_configuration: NotRequired[EncryptionConfiguration]

Specifies the encryption configuration for your IAM Identity Center instance. You can use this to configure customer managed KMS keys or Amazon Web Services owned KMS keys for encrypting your instance data.

instance_arn instance-attribute

instance_arn: InstanceArn

The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

name instance-attribute

name: NotRequired[NameType]

Updates the instance name.

permission_sets_enabled instance-attribute

permission_sets_enabled: NotRequired[bool]

Enables permission sets for this Identity Center instance. The only accepted value is true . After permission sets are enabled, they cannot be disabled.

You can't set EncryptionConfiguration and PermissionSetsEnabled in the same request. To configure both, make two separate UpdateInstance calls. These calls can be made in parallel.