UpdateConnector - AWS Transfer Family
Sintaxis de la solicitudParámetros de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

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.

UpdateConnector

Actualiza algunos de los parámetros de un conector existente. Proporcione el valor ConnectorId del conector que desee actualizar, junto con los nuevos valores de los parámetros que desee actualizar.

Sintaxis de la solicitud

{
   "AccessRole": "string",
   "As2Config": { 
      "BasicAuthSecretId": "string",
      "Compression": "string",
      "EncryptionAlgorithm": "string",
      "LocalProfileId": "string",
      "MdnResponse": "string",
      "MdnSigningAlgorithm": "string",
      "MessageSubject": "string",
      "PartnerProfileId": "string",
      "SigningAlgorithm": "string"
   },
   "ConnectorId": "string",
   "LoggingRole": "string",
   "SftpConfig": { 
      "TrustedHostKeys": [ "string" ],
      "UserSecretId": "string"
   },
   "Url": "string"
}

Parámetros de la 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 JSON formato.

AccessRole

Los conectores se utilizan para enviar archivos mediante el SFTP protocolo AS2 o. Para la función de acceso, proporcione el nombre de recurso de Amazon (ARN) de la AWS Identity and Access Management función que se va a utilizar.

Para AS2 conectores

ConAS2, puede enviar archivos llamando StartFileTransfer y especificando las rutas de los archivos en el parámetro de solicitud,SendFilePaths. Usamos el directorio principal del archivo (por ejemplo, el directorio principal es/bucket/dir/) para --send-file-paths /bucket/dir/file.txt almacenar temporalmente un archivo de AS2 mensajes procesado, almacenarlo MDN cuando lo recibimos del socio y escribir un JSON archivo final que contiene los metadatos relevantes de la transmisión. Por lo tanto, AccessRole debe proporcionar acceso de lectura y escritura al directorio principal de la ubicación del archivo que se utiliza en la solicitud StartFileTransfer. Además, debe proporcionar acceso de lectura y escritura al directorio principal de los archivos que desea enviar con StartFileTransfer.

Si utiliza la autenticación básica para su AS2 conector, la función de acceso requiere el secretsmanager:GetSecretValue permiso del secreto. Si el secreto se cifra con una clave gestionada por el cliente en lugar de la clave AWS gestionada en Secrets Manager, el rol también necesitará el kms:Decrypt permiso para esa clave.

Para conectores SFTP

Asegúrese de que el acceso al rol proporcione acceso de lectura y escritura al directorio principal de la ubicación del archivo que se utiliza en la solicitud StartFileTransfer. Además, asegúrese de que el rol dé secretsmanager:GetSecretValue permiso a AWS Secrets Manager.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 2048 caracteres.

Patrón: arn:.*role/\S+

Obligatorio: no

As2Config

Estructura que contiene los parámetros de un objeto AS2 conector.

Tipo: objeto As2ConnectorConfig

Obligatorio: no

ConnectorId

Un identificador único para el conector.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

Patrón: c-([0-9a-f]{17})

Obligatorio: sí

LoggingRole

El nombre del recurso de Amazon (ARN) de la función AWS Identity and Access Management (IAM) que permite a un conector activar el CloudWatch registro de eventos de Amazon S3. Cuando esté configurado, podrá ver la actividad del conector en sus CloudWatch registros.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 2048 caracteres.

Patrón: arn:.*role/\S+

Obligatorio: no

SftpConfig

Estructura que contiene los parámetros de un objeto SFTP conector.

Tipo: objeto SftpConnectorConfig

Obligatorio: no

Url

El URL del SFTP punto final AS2 o del socio.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 255 caracteres.

Obligatorio: no

Sintaxis de la respuesta

{
   "ConnectorId": "string"
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta de HTTP 200.

El servicio devuelve los siguientes datos en JSON formato.

ConnectorId

Devuelve el identificador del objeto conector que está actualizando.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

Patrón: c-([0-9a-f]{17})

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

InternalServiceError

Esta excepción se produce cuando se produce un error en el AWS Transfer Family servicio.

HTTPCódigo de estado: 500

InvalidRequestException

Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.

HTTPCódigo de estado: 400

ResourceExistsException

El recurso solicitado no existe o existe en una región distinta de la especificada para el comando.

HTTPCódigo de estado: 400

ResourceNotFoundException

Esta excepción se produce cuando el servicio AWS Transfer Family no encuentra un recurso.

HTTPCódigo de estado: 400

ServiceUnavailableException

La solicitud ha fallado porque el servicio AWS Transfer Family no está disponible.

HTTPCódigo de estado: 500

ThrottlingException

La solicitud fue denegada debido a una limitación de la solicitud.

HTTPCódigo de estado: 400

Véase también

Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: