SSOAdmin / Client / update_instance

update_instance

SSOAdmin.Client.update_instance(**kwargs)

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

In a single UpdateInstance 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 UpdateInstance separately for each. The two calls can be made in parallel.

See also: AWS API Documentation

Request Syntax

response = client.update_instance(
    Name='string',
    InstanceArn='string',
    EncryptionConfiguration={
        'KeyType': 'AWS_OWNED_KMS_KEY'|'CUSTOMER_MANAGED_KEY',
        'KmsKeyArn': 'string'
    },
    PermissionSetsEnabled=True|False
)
Parameters:

  • Name (string) – Updates the instance name.

  • InstanceArn (string) –

    [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 (dict) –

    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.

    • KeyType (string) – [REQUIRED]

      The type of KMS key used for encryption.

    • KmsKeyArn (string) –

      The ARN of the KMS key used to encrypt data. Required when KeyType is CUSTOMER_MANAGED_KEY. Cannot be specified when KeyType is AWS_OWNED_KMS_KEY.

  • PermissionSetsEnabled (boolean) –

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

    Note

    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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions