Skip to content

/AWS1/IF_RSS=>UPDATENAMESPACE()

About UpdateNamespace

Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.

Method Signature

METHODS /AWS1/IF_RSS~UPDATENAMESPACE
  IMPORTING
    !IV_NAMESPACENAME TYPE /AWS1/RSSNAMESPACENAME OPTIONAL
    !IV_ADMINUSERPASSWORD TYPE /AWS1/RSSDBPASSWORD OPTIONAL
    !IV_ADMINUSERNAME TYPE /AWS1/RSSDBUSER OPTIONAL
    !IV_KMSKEYID TYPE /AWS1/RSSSTRING OPTIONAL
    !IV_DEFAULTIAMROLEARN TYPE /AWS1/RSSSTRING OPTIONAL
    !IT_IAMROLES TYPE /AWS1/CL_RSSIAMROLEARNLIST_W=>TT_IAMROLEARNLIST OPTIONAL
    !IT_LOGEXPORTS TYPE /AWS1/CL_RSSLOGEXPORTLIST_W=>TT_LOGEXPORTLIST OPTIONAL
    !IV_MANAGEADMINPASSWORD TYPE /AWS1/RSSBOOLEAN OPTIONAL
    !IV_ADMINPASSWORDSECRETKMSK00 TYPE /AWS1/RSSKMSKEYID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rssupdatenamespacersp
  RAISING
    /AWS1/CX_RSSCONFLICTEXCEPTION
    /AWS1/CX_RSSINTERNALSERVEREX
    /AWS1/CX_RSSRESOURCENOTFOUNDEX
    /AWS1/CX_RSSVALIDATIONEX
    /AWS1/CX_RSSCLIENTEXC
    /AWS1/CX_RSSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_namespacename TYPE /AWS1/RSSNAMESPACENAME /AWS1/RSSNAMESPACENAME

The name of the namespace to update. You can't update the name of a namespace once it is created.

Optional arguments:

iv_adminuserpassword TYPE /AWS1/RSSDBPASSWORD /AWS1/RSSDBPASSWORD

The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername.

You can't use adminUserPassword if manageAdminPassword is true.

iv_adminusername TYPE /AWS1/RSSDBUSER /AWS1/RSSDBUSER

The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.

iv_kmskeyid TYPE /AWS1/RSSSTRING /AWS1/RSSSTRING

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

iv_defaultiamrolearn TYPE /AWS1/RSSSTRING /AWS1/RSSSTRING

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together with iamRoles.

it_iamroles TYPE /AWS1/CL_RSSIAMROLEARNLIST_W=>TT_IAMROLEARNLIST TT_IAMROLEARNLIST

A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.

it_logexports TYPE /AWS1/CL_RSSLOGEXPORTLIST_W=>TT_LOGEXPORTLIST TT_LOGEXPORTLIST

The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.

iv_manageadminpassword TYPE /AWS1/RSSBOOLEAN /AWS1/RSSBOOLEAN

If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.

iv_adminpasswordsecretkmsk00 TYPE /AWS1/RSSKMSKEYID /AWS1/RSSKMSKEYID

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.

RETURNING

oo_output TYPE REF TO /aws1/cl_rssupdatenamespacersp /AWS1/CL_RSSUPDATENAMESPACERSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

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->updatenamespace(
  it_iamroles = VALUE /aws1/cl_rssiamrolearnlist_w=>tt_iamrolearnlist(
    ( new /aws1/cl_rssiamrolearnlist_w( |string| ) )
  )
  it_logexports = VALUE /aws1/cl_rsslogexportlist_w=>tt_logexportlist(
    ( new /aws1/cl_rsslogexportlist_w( |string| ) )
  )
  iv_adminpasswordsecretkmsk00 = |string|
  iv_adminusername = |string|
  iv_adminuserpassword = |string|
  iv_defaultiamrolearn = |string|
  iv_kmskeyid = |string|
  iv_manageadminpassword = ABAP_TRUE
  iv_namespacename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_namespace = lo_result->get_namespace( ).
  IF lo_namespace IS NOT INITIAL.
    lv_string = lo_namespace->get_namespacearn( ).
    lv_string = lo_namespace->get_namespaceid( ).
    lv_namespacename = lo_namespace->get_namespacename( ).
    lv_dbuser = lo_namespace->get_adminusername( ).
    lv_string = lo_namespace->get_dbname( ).
    lv_string = lo_namespace->get_kmskeyid( ).
    lv_string = lo_namespace->get_defaultiamrolearn( ).
    LOOP AT lo_namespace->get_iamroles( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_iamrolearn = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_namespace->get_logexports( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_logexport = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_namespacestatus = lo_namespace->get_status( ).
    lv_timestamp = lo_namespace->get_creationdate( ).
    lv_string = lo_namespace->get_adminpasswordsecretarn( ).
    lv_kmskeyid = lo_namespace->get_adminpasswordsecretkms00( ).
    lv_string = lo_namespace->get_lakehouseregstatus( ).
    lv_string = lo_namespace->get_catalogarn( ).
  ENDIF.
ENDIF.