DataSync / Client / create_agent

create_agent

DataSync.Client.create_agent(**kwargs)

Activates an DataSync agent that you have deployed in your storage environment. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.

You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.

Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.

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]

  Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.

  The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.

  For more information, see Activating an Agent in the DataSync User Guide.

• AgentName (string) – The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.

• Tags (list) –

  The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.

  Note

  Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

  • (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) –

  The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side VPC endpoint, also called a PrivateLink. If you don’t have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

  VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

• SubnetArns (list) –

  The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.

  • (string) –

• SecurityGroupArns (list) –

  The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AgentArn': 'string'
}

Response Structure

• (dict) –

  CreateAgentResponse

  • AgentArn (string) –

    The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation to return a list of agents for your account and Amazon Web Services Region.

Exceptions

• DataSync.Client.exceptions.InvalidRequestException

• DataSync.Client.exceptions.InternalException