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.

  • Update the network configuration of the instance by specifying NetworkConfiguration.

A request that specifies more than one of EncryptionConfiguration, PermissionSetsEnabled, and NetworkConfiguration returns a ValidationException. To perform more than one of these operations, call UpdateInstance separately for each. The 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,
    NetworkConfiguration={
        'VpceAccessRequired': True|False,
        'RestrictSourceVpcs': [
            'string',
        ],
        'AllowSourceIps': [
            'string',
        ],
        'ExcludeApplicationArns': [
            '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 or Amazon Web Services owned KMS keys for encrypting your instance data.

    Note

    You can’t set more than one of EncryptionConfiguration, PermissionSetsEnabled, and NetworkConfiguration in the same request. To configure more than one of them, make a separate UpdateInstance call for each. These calls can be made in parallel.

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

  • NetworkConfiguration (dict) –

    Specifies the network access controls for your Identity Center instance. Use this to require that access to your instance and to applications originates from VPC endpoints, and to optionally restrict which VPCs are permitted, allow specific IP address ranges that bypass the VPC endpoint requirement, or exempt specific applications from the controls.

    If you omit NetworkConfiguration, the stored network configuration is preserved. If you specify NetworkConfiguration, it replaces the stored network configuration in its entirety. Any list that you omit from the object, or include as an empty list, is cleared.

    • VpceAccessRequired (boolean) – [REQUIRED]

      Specifies whether access to your Identity Center instance and to applications must originate from a VPC endpoint. When this value is true and no other field is specified, access is allowed from any VPC in your organization, or from any VPC in the Amazon Web Services account for an account instance, and applies to all applications. When this value is false, no network access control is enforced and the values of RestrictSourceVpcs, AllowSourceIps, and ExcludeApplicationArns are cleared.

    • RestrictSourceVpcs (list) –

      Limits access to the VPC endpoints in the VPCs that you specify. These VPCs must be in your organization, or in the Amazon Web Services account for an account instance. If you don’t specify this value, access is allowed from any VPC in your organization or Amazon Web Services account.

      • (string) –

    • AllowSourceIps (list) –

      Allows access from the IPv4 or IPv6 CIDR blocks that you specify, in addition to the VPCs allowed by RestrictSourceVpcs. If you don’t specify this value, no additional IP address ranges are allowed.

      • (string) –

    • ExcludeApplicationArns (list) –

      Exempts the applications that you specify from the network access control, so that access to them is unchanged. You can specify both Amazon Web Services managed applications and customer managed applications, and you can use wildcards. These applications are not restricted by RestrictSourceVpcs or AllowSourceIps. If you don’t specify this value, the controls apply to all applications.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions