Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
CreateAgent
Activa un AWS DataSync agente que ha implementado en su entorno de almacenamiento. El proceso de activación asocia el agente a suCuenta de AWS.
Si aún no ha desplegado un agente, consulte los siguientes temas para obtener más información:
nota
Si realiza una transferencia entre servicios AWS de almacenamiento, no necesita un DataSync agente.
Sintaxis de la solicitud
{
"ActivationKey": "string",
"AgentName": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcEndpointId": "string"
}Parámetros de solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
La solicitud acepta los siguientes datos en formato JSON.
- ActivationKey
-
Especifica la clave de activación del DataSync agente. Si no tienes una clave de activación, consulta Activar tu agente.
Tipo: String
Limitaciones de longitud: longitud máxima de 29 caracteres.
Patrón:
[A-Z0-9]{5}(-[A-Z0-9]{5}){4}Obligatorio: sí
- AgentName
-
Especifica un nombre para el agente. Puede ver este nombre en la DataSync consola.
Tipo: String
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.
Patrón:
^[a-zA-Z0-9\s+=._:@/-]+$Obligatorio: no
- SecurityGroupArns
-
Especifica el nombre de recurso de Amazon (ARN) del grupo de seguridad que protege las interfaces de red de la tarea cuando se utiliza un punto final de nube privada virtual (VPC).
Tipo: matriz de cadenas
Miembros de la matriz: número fijo de 1 elemento.
Limitaciones de longitud: longitud máxima de 128 caracteres.
Patrón:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$Obligatorio: no
- SubnetArns
-
Especifica el ARN de la subred en la que desea ejecutar la DataSync tarea cuando se utiliza un punto final de VPC. Esta es la subred en la que se DataSync crean y administran las interfaces de red para la transferencia.
Tipo: matriz de cadenas
Miembros de la matriz: número fijo de 1 elemento.
Limitaciones de longitud: longitud máxima de 128 caracteres.
Patrón:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$Obligatorio: no
- Tags
-
Especifica las etiquetas que le ayudan a clasificar, filtrar y buscar sus recursos de AWS. Le recomendamos crear al menos una etiqueta para el agente.
Tipo: Matriz de objetos TagListEntry
Miembros de la matriz: número mínimo de 0 elementos. Número máximo de 50 elementos.
Obligatorio: no
- VpcEndpointId
-
Especifica el ID del punto de enlace de la VPC al que desea que se conecte el agente. Por ejemplo, se ve el ID de punto de enlace de la VPC.
vpce-01234d5aff67890e1importante
El extremo de VPC que utilice debe incluir el nombre del DataSync servicio (por ejemplo,
com.amazonaws.us-east-2.datasync).Tipo: String
Patrón:
^vpce-[0-9a-f]{17}$Obligatorio: no
Sintaxis de la respuesta
{
"AgentArn": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- AgentArn
-
El ARN del agente que acabas de activar. Utilice la ListAgentsoperación para obtener una lista de los agentes que tiene en su Cuenta de AWS manoRegión de AWS.
Tipo: String
Limitaciones de longitud: longitud máxima de 128 caracteres.
Patrón:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$
Errores
Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.
- InternalException
-
Esta excepción se produce cuando se produce un error en el AWS DataSync servicio.
Código de estado HTTP: 500
- InvalidRequestException
-
Esta excepción se produce cuando el cliente envía una solicitud con formato incorrecto.
Código de estado HTTP: 400
Ejemplos
Solicitud de muestra
El siguiente ejemplo activa un DataSync agente y lo asocia a suCuenta de AWS.
{ "ActivationKey": "AAAAA-1AAAA-BB1CC-33333-EEEEE", "AgentName": "MyAgent", "Tags": [{ "Key": "Job", "Value": "TransferJob-1" }] }
Respuesta de ejemplo
La respuesta devuelve el ARN del agente activado.
{ "AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3" }
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte:
