Skip to content

Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account

Description

Update the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.

In a single update_instance request, you can perform only one of the following operations:

  • Update the encryption configuration of the instance by specifying EncryptionConfiguration.
  • Enable permission sets for the instance by specifying PermissionSetsEnabled.

A request that specifies both EncryptionConfiguration and PermissionSetsEnabled returns a ValidationException. To perform both operations, call update_instance separately for each. The two calls can be made in parallel.

Usage

ssoadmin_update_instance(Name, InstanceArn, EncryptionConfiguration,
  PermissionSetsEnabled)

Arguments

  • Name

    Updates the instance name.

  • InstanceArn

    [required] 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.

  • 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.

  • PermissionSetsEnabled

    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 update_instance calls. These calls can be made in parallel.

Value

An empty list.

Request syntax

svc$update_instance(
  Name = "string",
  InstanceArn = "string",
  EncryptionConfiguration = list(
    KeyType = "AWS_OWNED_KMS_KEY"|"CUSTOMER_MANAGED_KEY",
    KmsKeyArn = "string"
  ),
  PermissionSetsEnabled = TRUE|FALSE
)