DESCRIBESCALINGPARAMETERS()`¶

About DescribeScalingParameters¶

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

Method Signature¶

METHODS /AWS1/IF_SRH~DESCRIBESCALINGPARAMETERS
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/SRHDOMAINNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_srhdescrscaparamsrsp
  RAISING
    /AWS1/CX_SRHBASEEXCEPTION
    /AWS1/CX_SRHINTERNALEXCEPTION
    /AWS1/CX_SRHRESOURCENOTFOUNDEX
    /AWS1/CX_SRHCLIENTEXC
    /AWS1/CX_SRHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_domainname` `TYPE /AWS1/SRHDOMAINNAME` `/AWS1/SRHDOMAINNAME`¶

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_srhdescrscaparamsrsp` `/AWS1/CL_SRHDESCRSCAPARAMSRSP`¶

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->describescalingparameters( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_scalingparametersstatus = lo_result->get_scalingparameters( ).
  IF lo_scalingparametersstatus IS NOT INITIAL.
    lo_scalingparameters = lo_scalingparametersstatus->get_options( ).
    IF lo_scalingparameters IS NOT INITIAL.
      lv_partitioninstancetype = lo_scalingparameters->get_desiredinstancetype( ).
      lv_uintvalue = lo_scalingparameters->get_desiredreplicationcount( ).
      lv_uintvalue = lo_scalingparameters->get_desiredpartitioncount( ).
    ENDIF.
    lo_optionstatus = lo_scalingparametersstatus->get_status( ).
    IF lo_optionstatus IS NOT INITIAL.
      lv_updatetimestamp = lo_optionstatus->get_creationdate( ).
      lv_updatetimestamp = lo_optionstatus->get_updatedate( ).
      lv_uintvalue = lo_optionstatus->get_updateversion( ).
      lv_optionstate = lo_optionstatus->get_state( ).
      lv_boolean = lo_optionstatus->get_pendingdeletion( ).
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/IF_SRH=>DESCRIBESCALINGPARAMETERS()¶