DESCRIBEAUTHNTCTNPROFILE()`¶

About DescribeAuthenticationProfile¶

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

Describes the target authentication profile.

Method Signature¶

METHODS /AWS1/IF_CNT~DESCRIBEAUTHNTCTNPROFILE
  IMPORTING
    !IV_AUTHENTICATIONPROFILEID TYPE /AWS1/CNTAUTHNTCTNPROFILEID OPTIONAL
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntdscauthnprofilersp
  RAISING
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_authenticationprofileid` `TYPE /AWS1/CNTAUTHNTCTNPROFILEID` `/AWS1/CNTAUTHNTCTNPROFILEID`¶

A unique identifier for the authentication profile.

`iv_instanceid` `TYPE /AWS1/CNTINSTANCEID` `/AWS1/CNTINSTANCEID`¶

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntdscauthnprofilersp` `/AWS1/CL_CNTDSCAUTHNPROFILERSP`¶

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->describeauthntctnprofile(
  iv_authenticationprofileid = |string|
  iv_instanceid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_authenticationprofile = lo_result->get_authenticationprofile( ).
  IF lo_authenticationprofile IS NOT INITIAL.
    lv_authenticationprofileid = lo_authenticationprofile->get_id( ).
    lv_arn = lo_authenticationprofile->get_arn( ).
    lv_authenticationprofilena = lo_authenticationprofile->get_name( ).
    lv_authenticationprofilede = lo_authenticationprofile->get_description( ).
    LOOP AT lo_authenticationprofile->get_allowedips( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_ipcidr = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_authenticationprofile->get_blockedips( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_ipcidr = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_boolean = lo_authenticationprofile->get_isdefault( ).
    lv_timestamp = lo_authenticationprofile->get_createdtime( ).
    lv_timestamp = lo_authenticationprofile->get_lastmodifiedtime( ).
    lv_regionname = lo_authenticationprofile->get_lastmodifiedregion( ).
    lv_accesstokenduration = lo_authenticationprofile->get_periodicsessionduration( ).
    lv_refreshtokenduration = lo_authenticationprofile->get_maxsessionduration( ).
    lv_inactivityduration = lo_authenticationprofile->get_sessioninactivitydur( ).
    lv_boolean = lo_authenticationprofile->get_sessinactivityhandling00( ).
  ENDIF.
ENDIF.

/AWS1/IF_CNT=>DESCRIBEAUTHNTCTNPROFILE()¶