DataSync / Client / create_agent

create_agent

DataSync.Client.create_agent(**kwargs)

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?

See also: AWS API Documentation

Request Syntax

response = client.create_agent(
    ActivationKey='string',
    AgentName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    VpcEndpointId='string',
    SubnetArns=[
        'string',
    ],
    SecurityGroupArns=[
        'string',
    ]
)
Parameters:

  • ActivationKey (string) –

    [REQUIRED]

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

  • AgentName (string) – Specifies a name for your agent. We recommend specifying a name that you can remember.

  • Tags (list) –

    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.

    • (dict) –

      A key-value pair representing a single tag that’s been applied to an Amazon Web Services resource.

      • Key (string) – [REQUIRED]

        The key for an Amazon Web Services resource tag.

      • Value (string) –

        The value for an Amazon Web Services resource tag.

  • VpcEndpointId (string) –

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

    Warning

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

    The endpoint ID is informational. DataSync doesn’t verify it or use it to connect to your agent. For more information, see Using a single VPC service endpoint across multiple subnets.

  • SubnetArns (list) –

    Specifies the ARN of the subnet where DataSync creates the network interfaces that handle data transfer traffic for your tasks. You can only specify one ARN.

    The subnet doesn’t have to be the subnet that contains your VPC service endpoint. The subnet can be one that another Amazon Web Services account shared with you through RAM, in which case the ARN must specify the account that owns the subnet. For more information, see Using a single VPC service endpoint across multiple subnets.

    • (string) –

  • SecurityGroupArns (list) –

    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.

    The ARN must specify your own account, even when the security group was shared with you from the account that owns the VPC. The security group must belong to the same VPC as the subnet that you specify in SubnetArns.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AgentArn': 'string'
}

Response Structure

  • (dict) –

    CreateAgentResponse

    • AgentArn (string) –

      The ARN of the agent that you just activated. Use the ListAgents operation to return a list of agents in your Amazon Web Services account and Amazon Web Services Region.

Exceptions