Skip to content

/AWS1/CL_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

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