Skip to content

/AWS1/IF_DSR=>STARTADASSESSMENT()

About StartADAssessment

Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join. The assessment checks compatibility and connectivity of the self-managed AD environment.

A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

The assessment process typically takes 30 minutes or more to complete. The assessment process is asynchronous and you can monitor it with DescribeADAssessment.

The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

Note: You must provide exactly one DirectoryId or AssessmentConfiguration.

Method Signature

IMPORTING

Optional arguments:

io_assessmentconfiguration TYPE REF TO /AWS1/CL_DSRASSESSMENTCONF /AWS1/CL_DSRASSESSMENTCONF

Configuration parameters for the directory assessment, including DNS server information, domain name, Amazon VPC subnet, and Amazon Web Services System Manager managed node details.

iv_directoryid TYPE /AWS1/DSRDIRECTORYID /AWS1/DSRDIRECTORYID

The identifier of the directory for which to perform the assessment. This should be an existing directory. If the assessment is not for an existing directory, this parameter should be omitted.

RETURNING

oo_output TYPE REF TO /aws1/cl_dsrstrtadassessmentrs /AWS1/CL_DSRSTRTADASSESSMENTRS

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->/aws1/if_dsr~startadassessment(
  io_assessmentconfiguration = new /aws1/cl_dsrassessmentconf(
    io_vpcsettings = new /aws1/cl_dsrdirectoryvpcstgs(
      it_subnetids = VALUE /aws1/cl_dsrsubnetids_w=>tt_subnetids(
        ( new /aws1/cl_dsrsubnetids_w( |string| ) )
      )
      iv_vpcid = |string|
    )
    it_customerdnsips = VALUE /aws1/cl_dsrcustomerdnsips_w=>tt_customerdnsips(
      ( new /aws1/cl_dsrcustomerdnsips_w( |string| ) )
    )
    it_instanceids = VALUE /aws1/cl_dsrassessmentinstid00=>tt_assessmentinstanceids(
      ( new /aws1/cl_dsrassessmentinstid00( |string| ) )
    )
    it_securitygroupids = VALUE /aws1/cl_dsrsecuritygroupids_w=>tt_securitygroupids(
      ( new /aws1/cl_dsrsecuritygroupids_w( |string| ) )
    )
    iv_dnsname = |string|
  )
  iv_directoryid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_assessmentid = lo_result->get_assessmentid( ).
ENDIF.