Skip to content

/AWS1/IF_DSY=>CREATEAGENT()

About CreateAgent

Activates an DataSync agent that you deploy in your storage environment. The activation process associates the agent with your Amazon Web Services account.

If you haven't deployed an agent yet, see Do I need a DataSync agent?

Method Signature

METHODS /AWS1/IF_DSY~CREATEAGENT
  IMPORTING
    !IV_ACTIVATIONKEY TYPE /AWS1/DSYACTIVATIONKEY OPTIONAL
    !IV_AGENTNAME TYPE /AWS1/DSYTAGVALUE OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_DSYTAGLISTENTRY=>TT_INPUTTAGLIST OPTIONAL
    !IV_VPCENDPOINTID TYPE /AWS1/DSYVPCENDPOINTID OPTIONAL
    !IT_SUBNETARNS TYPE /AWS1/CL_DSYPLSUBNETARNLIST_W=>TT_PLSUBNETARNLIST OPTIONAL
    !IT_SECURITYGROUPARNS TYPE /AWS1/CL_DSYPLSECGRPARNLIST_W=>TT_PLSECURITYGROUPARNLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dsycreateagentrsp
  RAISING
    /AWS1/CX_DSYINTERNALEXCEPTION
    /AWS1/CX_DSYINVALIDREQUESTEX
    /AWS1/CX_DSYCLIENTEXC
    /AWS1/CX_DSYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_activationkey TYPE /AWS1/DSYACTIVATIONKEY /AWS1/DSYACTIVATIONKEY

Specifies your DataSync agent's activation key. If you don't have an activation key, see Activating your agent.

Optional arguments:

iv_agentname TYPE /AWS1/DSYTAGVALUE /AWS1/DSYTAGVALUE

Specifies a name for your agent. We recommend specifying a name that you can remember.

it_tags TYPE /AWS1/CL_DSYTAGLISTENTRY=>TT_INPUTTAGLIST TT_INPUTTAGLIST

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.

iv_vpcendpointid TYPE /AWS1/DSYVPCENDPOINTID /AWS1/DSYVPCENDPOINTID

Specifies the ID of the VPC service endpoint that you're using. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

The VPC service endpoint you use must include the DataSync service name (for example, com.amazonaws.us-east-2.datasync).

it_subnetarns TYPE /AWS1/CL_DSYPLSUBNETARNLIST_W=>TT_PLSUBNETARNLIST TT_PLSUBNETARNLIST

Specifies the ARN of the subnet where your VPC service endpoint is located. You can only specify one ARN.

it_securitygrouparns TYPE /AWS1/CL_DSYPLSECGRPARNLIST_W=>TT_PLSECURITYGROUPARNLIST TT_PLSECURITYGROUPARNLIST

Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between your agent and VPC service endpoint. You can only specify one ARN.

RETURNING

oo_output TYPE REF TO /aws1/cl_dsycreateagentrsp /AWS1/CL_DSYCREATEAGENTRSP

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->createagent(
  it_securitygrouparns = VALUE /aws1/cl_dsyplsecgrparnlist_w=>tt_plsecuritygrouparnlist(
    ( new /aws1/cl_dsyplsecgrparnlist_w( |string| ) )
  )
  it_subnetarns = VALUE /aws1/cl_dsyplsubnetarnlist_w=>tt_plsubnetarnlist(
    ( new /aws1/cl_dsyplsubnetarnlist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_dsytaglistentry=>tt_inputtaglist(
    (
      new /aws1/cl_dsytaglistentry(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_activationkey = |string|
  iv_agentname = |string|
  iv_vpcendpointid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_agentarn = lo_result->get_agentarn( ).
ENDIF.