GETPARAMETER()`¶

About GetParameter¶

Get information about a single parameter by specifying the parameter name.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

To get information about more than one parameter at a time, use the GetParameters operation.

Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can process. This applies to GetParameter, GetParameters, and PutParameter API calls for your Amazon Web Services account and Amazon Web Services Region. By default, Parameter Store is configured with a standard throughput quota suitable for low- to moderate-volume workloads. Applications that retrieve configuration data infrequently or operate at smaller scale can use this default setting without additional cost.

For higher-volume workloads, you can enable higher throughput. This increases the maximum number of supported transactions per second for your account and Region. Increased throughput supports applications and workloads that need concurrent access to multiple parameters. If you experience ThrottlingException: Rate exceeded errors, enable higher throughput. For more information, see Changing Parameter Store throughput.

Method Signature¶

METHODS /AWS1/IF_SSM~GETPARAMETER
  IMPORTING
    !IV_NAME TYPE /AWS1/SSMPSPARAMETERNAME OPTIONAL
    !IV_WITHDECRYPTION TYPE /AWS1/SSMBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmgetparameterresult
  RAISING
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMINVALIDKEYID
    /AWS1/CX_SSMPARAMETERNOTFOUND
    /AWS1/CX_SSMPARAMVRSNOTFOUND
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/SSMPSPARAMETERNAME` `/AWS1/SSMPSPARAMETERNAME`¶

The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.

To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

For more information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

Optional arguments:¶

`iv_withdecryption` `TYPE /AWS1/SSMBOOLEAN` `/AWS1/SSMBOOLEAN`¶

Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssmgetparameterresult` `/AWS1/CL_SSMGETPARAMETERRESULT`¶

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->getparameter(
  iv_name = |string|
  iv_withdecryption = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_parameter = lo_result->get_parameter( ).
  IF lo_parameter IS NOT INITIAL.
    lv_psparametername = lo_parameter->get_name( ).
    lv_parametertype = lo_parameter->get_type( ).
    lv_psparametervalue = lo_parameter->get_value( ).
    lv_psparameterversion = lo_parameter->get_version( ).
    lv_psparameterselector = lo_parameter->get_selector( ).
    lv_string = lo_parameter->get_sourceresult( ).
    lv_datetime = lo_parameter->get_lastmodifieddate( ).
    lv_string = lo_parameter->get_arn( ).
    lv_parameterdatatype = lo_parameter->get_datatype( ).
  ENDIF.
ENDIF.

/AWS1/IF_SSM=>GETPARAMETER()¶