UPDATEINSTANCE()`¶

About UpdateInstance¶

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.

Method Signature¶

METHODS /AWS1/IF_SSA~UPDATEINSTANCE
  IMPORTING
    !IV_NAME TYPE /AWS1/SSANAMETYPE OPTIONAL
    !IV_INSTANCEARN TYPE /AWS1/SSAINSTANCEARN OPTIONAL
    !IO_ENCRYPTIONCONFIGURATION TYPE REF TO /AWS1/CL_SSAENCRYPTIONCONF OPTIONAL
    !IV_PERMISSIONSETSENABLED TYPE /AWS1/SSABOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssaupdateinstresponse
  RAISING
    /AWS1/CX_SSAACCESSDENIEDEX
    /AWS1/CX_SSACONFLICTEXCEPTION
    /AWS1/CX_SSAINTERNALSERVEREX
    /AWS1/CX_SSARESOURCENOTFOUNDEX
    /AWS1/CX_SSATHROTTLINGEX
    /AWS1/CX_SSAVALIDATIONEX
    /AWS1/CX_SSACLIENTEXC
    /AWS1/CX_SSASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_instancearn` `TYPE /AWS1/SSAINSTANCEARN` `/AWS1/SSAINSTANCEARN`¶

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.

Optional arguments:¶

`iv_name` `TYPE /AWS1/SSANAMETYPE` `/AWS1/SSANAMETYPE`¶

Updates the instance name.

`io_encryptionconfiguration` `TYPE REF TO /AWS1/CL_SSAENCRYPTIONCONF` `/AWS1/CL_SSAENCRYPTIONCONF`¶

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.

`iv_permissionsetsenabled` `TYPE /AWS1/SSABOOLEAN` `/AWS1/SSABOOLEAN`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssaupdateinstresponse` `/AWS1/CL_SSAUPDATEINSTRESPONSE`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updateinstance(
  io_encryptionconfiguration = new /aws1/cl_ssaencryptionconf(
    iv_keytype = |string|
    iv_kmskeyarn = |string|
  )
  iv_instancearn = |string|
  iv_name = |string|
  iv_permissionsetsenabled = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_SSA=>UPDATEINSTANCE()¶