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.

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'
    }
)
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 (CMK) 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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions